Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-35675: Remove Gen2 #267

Merged
merged 9 commits into from
Jul 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/changes/DM-35675.api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Replaced ``CmdLineTask`` and ``ArgumentParser`` with non-functioning stubs, disabling all Gen2 functionality.
A deprecation message is now issued but the classes do nothing.
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
html_title = project
html_short_title = project
doxylink = {}
exclude_patterns = ["changes/*"]
255 changes: 0 additions & 255 deletions doc/lsst.pipe.base/creating-a-command-line-task.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/lsst.pipe.base/creating-a-pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Creating a Pipeline
**Note**
This guide assumes some knowledge about
`PipelineTask`\ s, and so if you would like you can check out
:doc:`Creating a PipelineTask <creating-a-pipelinetask.rst>` for info on what
:doc:`Creating a PipelineTask <creating-a-pipelinetask>` for info on what
a `PipelineTask` is and how to make one. Otherwise, this guide attempts to be
mostly stand alone, and should be readable with minimal references.

Expand Down
9 changes: 2 additions & 7 deletions doc/lsst.pipe.base/creating-a-task.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes how to write a data processing task.
For an introduction to data processing tasks, please read :doc:`task-framework-overview`.
It also helps to have a basic understanding of data repositories and how to use the butler to read and write data (to be written; for now read existing tasks to see how it is done).

After reading this document you may wish to read :doc:`creating-a-command-line-task`.
After reading this document you may wish to read :doc:`creating-a-pipelinetask`.

.. _creating-a-task-intro:

Expand All @@ -23,7 +23,6 @@ Tasks are subclasses of `lsst.pipe.base.Task` in general or `lsst.pipe.base.CmdL
Tasks are constructed by calling ``__init__`` with the :ref:`task configuration <creating-a-task-configuration>`.
Occasionally additional arguments are required (see the task's documentation for details).
`lsst.pipe.base.Task` has a few other arguments that are usually only specified when a task is created as a subtask of another task; you will probably never have to specify them yourself.
(Command-line tasks are often constructed and run by calling `lsst.pipe.base.parseAndRun`, as described in :doc:`creating-a-command-line-task`.)

Tasks typically have a ``run`` method that executes the task's main function.
See :ref:`creating-a-task-class-methods` for more information.
Expand Down Expand Up @@ -114,11 +113,7 @@ Tasks require several class variables to function:
For example ``exampleCmdLineTask.ExampleCmdLineConfig`` creates the statistics subtask with name ``stats`` because the config field for that subtask is ``stats = lsst.pex.config.ConfigurableField(...)``.

Task names are used for the hierarchy of task and subtask metadata.
Also, for command-line tasks the name is used as a component of the of the dataset type for saving the task's configuration and metadata; see :ref:`creating-a-command-line-task-persisting-config-and-metadata` for more information.

- ``RunnerClass``: only needed for command-line tasks; see :doc:`creating-a-command-line-task` for more information.

- ``canMultiprocess``: only needed for command-line tasks; see :doc:`creating-a-command-line-task` for more information.
Also, for command-line tasks the name is used as a component of the of the dataset type for saving the task's configuration and metadata.

Here are the class variables for ``ExampleCmdLineTask``:

Expand Down
1 change: 0 additions & 1 deletion doc/lsst.pipe.base/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ Developing tasks and command-line tasks
:maxdepth: 1

creating-a-task.rst
creating-a-command-line-task.rst
testing-a-pipeline-task.rst
creating-a-pipelinetask.rst

Expand Down