Renamed command_definition.py to command_set.py.

kmvanbrunt · kmvanbrunt · commit 697da11940aa · 2026-04-07T03:51:20.000-04:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -31,7 +31,7 @@ cmd2/argparse_*.py         @kmvanbrunt
 cmd2/clipboard.py          @tleonhardt
 cmd2/cmd2.py               @tleonhardt @kmvanbrunt
 cmd2/colors.py             @tleonhardt @kmvanbrunt
-cmd2/command_definition.py @kmvanbrunt
+cmd2/command_set.py        @kmvanbrunt
 cmd2/completion.py         @kmvanbrunt
 cmd2/constants.py          @tleonhardt @kmvanbrunt
 cmd2/decorators.py         @kmvanbrunt
diff --git a/cmd2/__init__.py b/cmd2/__init__.py
@@ -19,7 +19,7 @@
 )
 from .cmd2 import Cmd
 from .colors import Color
-from .command_definition import CommandSet
+from .command_set import CommandSet
 from .completion import (
     Choices,
     CompletionItem,
diff --git a/cmd2/argparse_completer.py b/cmd2/argparse_completer.py
@@ -29,7 +29,7 @@
     Cmd2ArgumentParser,
     build_range_error,
 )
-from .command_definition import CommandSet
+from .command_set import CommandSet
 from .completion import (
     CompletionItem,
     Completions,
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
@@ -115,7 +115,7 @@
     get_paste_buffer,
     write_to_paste_buffer,
 )
-from .command_definition import (
+from .command_set import (
     CommandFunc,
     CommandSet,
 )
diff --git a/cmd2/command_set.py b/cmd2/command_set.py
diff --git a/cmd2/decorators.py b/cmd2/decorators.py
@@ -14,7 +14,7 @@
 
 from . import constants
 from .argparse_custom import Cmd2ArgumentParser
-from .command_definition import (
+from .command_set import (
     CommandFunc,
     CommandSet,
 )
diff --git a/cmd2/types.py b/cmd2/types.py
@@ -14,7 +14,7 @@
 
 if TYPE_CHECKING:  # pragma: no cover
     from .cmd2 import Cmd
-    from .command_definition import CommandSet
+    from .command_set import CommandSet
     from .completion import Choices, Completions
 
 # A Cmd or CommandSet
diff --git a/docs/api/command_definition.md b/docs/api/command_definition.md
diff --git a/docs/api/command_set.md b/docs/api/command_set.md
@@ -0,0 +1,3 @@
+# cmd2.command_set
+
+::: cmd2.command_set
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -16,8 +16,8 @@ incremented according to the [Semantic Version Specification](https://semver.org
 - [cmd2.argparse_custom](./argparse_custom.md) - classes and functions for extending `argparse`
 - [cmd2.clipboard](./clipboard.md) - functions to copy from and paste to the clipboard/pastebuffer
 - [cmd2.colors](./colors.md) - StrEnum of all color names supported by the Rich library
-- [cmd2.command_definition](./command_definition.md) - supports the definition of commands in
-  separate classes to be composed into cmd2.Cmd
+- [cmd2.command_set](./command_set.md) - supports the definition of commands in separate classes to
+  be composed into cmd2.Cmd
 - [cmd2.completion](./completion.md) - classes and functions related to command-line completion
 - [cmd2.constants](./constants.md) - constants used in `cmd2`
 - [cmd2.decorators](./decorators.md) - decorators for `cmd2` commands
diff --git a/docs/features/modular_commands.md b/docs/features/modular_commands.md
@@ -222,21 +222,21 @@ if __name__ == '__main__':
 The following functions are called at different points in the [CommandSet][cmd2.CommandSet] life
 cycle.
 
-[on_register][cmd2.command_definition.CommandSet.on_register] - Called by `cmd2.Cmd` as the first
-step to registering a `CommandSet`. The commands defined in this class have not be added to the CLI
-object at this point. Subclasses can override this to perform any initialization requiring access to
-the Cmd object (e.g. configure commands and their parsers based on CLI state data).
+[on_register][cmd2.command_set.CommandSet.on_register] - Called by `cmd2.Cmd` as the first step to
+registering a `CommandSet`. The commands defined in this class have not be added to the CLI object
+at this point. Subclasses can override this to perform any initialization requiring access to the
+Cmd object (e.g. configure commands and their parsers based on CLI state data).
 
-[on_registered][cmd2.command_definition.CommandSet.on_registered] - Called by `cmd2.Cmd` after a
+[on_registered][cmd2.command_set.CommandSet.on_registered] - Called by `cmd2.Cmd` after a
 `CommandSet` is registered and all its commands have been added to the CLI. Subclasses can override
 this to perform custom steps related to the newly added commands (e.g. setting them to a disabled
 state).
 
-[on_unregister][cmd2.command_definition.CommandSet.on_unregister] - Called by `cmd2.Cmd` as the
-first step to unregistering a `CommandSet`. Subclasses can override this to perform any cleanup
-steps which require their commands being registered in the CLI.
+[on_unregister][cmd2.command_set.CommandSet.on_unregister] - Called by `cmd2.Cmd` as the first step
+to unregistering a `CommandSet`. Subclasses can override this to perform any cleanup steps which
+require their commands being registered in the CLI.
 
-[on_unregistered][cmd2.command_definition.CommandSet.on_unregistered] - Called by `cmd2.Cmd` after a
+[on_unregistered][cmd2.command_set.CommandSet.on_unregistered] - Called by `cmd2.Cmd` after a
 `CommandSet` has been unregistered and all its commands removed from the CLI. Subclasses can
 override this to perform remaining cleanup steps.
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -198,7 +198,7 @@ nav:
       - api/argparse_custom.md
       - api/clipboard.md
       - api/colors.md
-      - api/command_definition.md
+      - api/command_set.md
       - api/completion.md
       - api/constants.md
       - api/decorators.md

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`)`
`20`	`20`	`from .cmd2 import Cmd`
`21`	`21`	`from .colors import Color`
`22`		`-from .command_definition import CommandSet`
	`22`	`+from .command_set import CommandSet`
`23`	`23`	`from .completion import (`
`24`	`24`	`Choices,`
`25`	`25`	`CompletionItem,`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`Cmd2ArgumentParser,`
`30`	`30`	`build_range_error,`
`31`	`31`	`)`
`32`		`-from .command_definition import CommandSet`
	`32`	`+from .command_set import CommandSet`
`33`	`33`	`from .completion import (`
`34`	`34`	`CompletionItem,`
`35`	`35`	`Completions,`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@`
`115`	`115`	`get_paste_buffer,`
`116`	`116`	`write_to_paste_buffer,`
`117`	`117`	`)`
`118`		`-from .command_definition import (`
	`118`	`+from .command_set import (`
`119`	`119`	`CommandFunc,`
`120`	`120`	`CommandSet,`
`121`	`121`	`)`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`
`15`	`15`	`from . import constants`
`16`	`16`	`from .argparse_custom import Cmd2ArgumentParser`
`17`		`-from .command_definition import (`
	`17`	`+from .command_set import (`
`18`	`18`	`CommandFunc,`
`19`	`19`	`CommandSet,`
`20`	`20`	`)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.command_set`
	`2`	`+`
	`3`	`+::: cmd2.command_set`