Use docstring to annotate pipen processes
Installation
pip install -U pipen-annotate
Usage
from pprint import pprint
from pipen import Proc
from pipen_annotate import annotate
class Process(Proc):
"""Short description
Long description
Input:
infile: An input file
invar: An input variable
Output:
outfile: The output file
Envs:
ncores (type=int): Number of cores
"""
input = "infile:file, invar"
output = "outfile:file:output.txt"
args = {'ncores': 1}
annotated = annotate(Process)
# returns:
{'Envs': {'ncores': {'attrs': {'type': 'int'},
'help': 'Number of cores',
'name': 'ncores',
'terms': {}}},
'Input': {'infile': {'attrs': {'action': 'extend',
'itype': 'file',
'nargs': '+'},
'help': 'An input file',
'name': 'infile',
'terms': {}},
'invar': {'attrs': {'action': 'extend',
'itype': 'var',
'nargs': '+'},
'help': 'An input variable',
'name': 'invar',
'terms': {}}},
'Output': {'outfile': {'attrs': {'default': 'output.txt', 'otype': 'file'},
'help': 'The output file',
'name': 'outfile',
'terms': {}}},
'Summary': {'long': 'Long description', 'short': 'Short description'}}
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pipen_annotate-1.0.6.tar.gz
(172.5 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pipen_annotate-1.0.6.tar.gz.
File metadata
- Download URL: pipen_annotate-1.0.6.tar.gz
- Upload date:
- Size: 172.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
191350427fd78d9f59da0c46443c2fa5aace7e30ec938193ca7e88e28b0c9f88
|
|
| MD5 |
0a842e3945886d1e1268cc32fd2e4893
|
|
| BLAKE2b-256 |
0575093158d77cc3900e2e68a91991ce6dd65e3f398f0864ddadf7fe45468402
|
File details
Details for the file pipen_annotate-1.0.6-py3-none-any.whl.
File metadata
- Download URL: pipen_annotate-1.0.6-py3-none-any.whl
- Upload date:
- Size: 10.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3829cf79166ee18eaae5460b02786a25728cb7be90902cf291090b77fad8a72e
|
|
| MD5 |
50ae1b19b8722ce7f25e3cec9857b14b
|
|
| BLAKE2b-256 |
c5cce2501177044311b9e0c5ded00867b31f46e2d374bdd28fe948149ef213ac
|
