Module as feature
The module as a feature is a standalone module that is not located in the package(I.E it is not a package as a feature).
It is a regular .py module file with functions in it - but it has no identical named function in it.
Let's add module as a feature called upload.py:
And add the docstring in the upload.py file:
If you run the CLI:
$ ./awesome -h
usage: awesome [-h] {service,upload,environment} ...
positional arguments:
{service,upload,environment}
service The service feature to handle our services # (1)
upload This is an example of module feature # (2)
environment The environment feature to handle our environments # (3)
optional arguments:
-h, --help show this help message and exit
- Package as a feature from storage_X
- Module as a feature from storage_X
- Package as a feature from storage_Y
Feature Commands
With package as a feature, the commands are modules with identically named functions in them.
In contrast, here we are going to add multiple functions in the upload.py - effectively multiple commands.
"""
This is an example of the module feature
"""
def new(name: str) -> None:
"""
uploads a new file
Args:
name (str): Name of file
Return: None
"""
print(f"This is a module as feature {name}")
def delete(name: str, environment: str) -> None:
"""
Deletes a file from the given environment
Args:
name (str): Name of project
environment (str): Name of the env
Return: None
"""
print(f"Delete a module as feature {name} {environment}")
def _init():
"""
This should not be shown
Return: None
"""
...
def __revert():
"""
This should not be shown
Return: None
"""
...
In Python convention something starting with a single and double underscore is considered "protected" and "private" respectively.
We like this idea and those commands(functions) are silently ignored and are not considered as commands:
$ ./awesome upload -h
usage: awesome upload [-h] {new,delete} ...
positional arguments:
{new,delete}
new uploads a new file
delete Deletes a file from given environment
optional arguments:
-h, --help show this help message and exit
Finally, let's run this new command:
$ ./awesome upload new -h
usage: awesome upload new [-h] name
positional arguments:
name Name of file
optional arguments:
-h, --help show this help message and exit
Versioning module as a feature
As with packages as features, you can add __version__ in the module as a feature to indicate your unique version:
"""
This is an example of the module feature
"""
__version__ = "5.0"
def new(name: str) -> None:
Now you can get the version as well:
Limiting the feature commands
If for some reason you have a "public" function in the module, and you do not want to expose it as a command you can limit it by using __all__.
Originally in Python __all__ only limits the imports such as: from something import *.
But here we use it just for eliminating the redundant operations when we register the feature commands:
"""
This is an example of the module feature
"""
__version__ = "5.0"
__all__ = ["new"]
def new(name: str) -> None:
Now if you look at the help of the feature:
$ ./awesome upload -h
usage: awesome upload [-h] [-v] {new} ...
positional arguments:
{new}
new uploads a new file
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
And if you try to bypass(because you are sure there is a delete function):
$ ./awesome upload delete -h
usage: awesome upload [-h] [-v] {new} ...
awesome upload: error: invalid choice: 'delete' (choose from 'new')
The next is to learn about top-level commands.