Dict with documentation _-_
Project description
doc_datatypes
Installation
git clone git@github.com:Kel0/doc_dict.git
pip install doc-dict
Usage
Documentable list
from doc_datatypes.mutable_datatypes import DocumentedList
from doc_datatypes.datatypes import DocumentedIndex
my_list: List[DocumentedIndex] = DocumentedList(
[1, 2, 3], ["First", "Second", "Third"]
)
my_list_2: List[DocumentedIndex] = DocumentedList(
[[1, "First"], [2, "Second"], [3, "Third"]]
)
Documentable dict
from doc_datatypes.mutable_datatypes import DocumentedDict
from doc_datatypes.datatypes import DocumentedValue
my_dict: Dict[str, DocumentedValue] = DocumentedDict(
{"name": "Alex"}, {"name": "Name field"}
)
my_dict_2: Dict[str, DocumentedValue] = DocumentedDict(
{"name": "Alex", "name_doc": "Name field"}
)
To get more info see tests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
doc_datatypes-0.0.4.tar.gz
(4.2 kB
view hashes)
Built Distribution
Close
Hashes for doc_datatypes-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46e998a536fad7491ff422e590096cfdcebf073c7003276e0df2edffc32b67b2 |
|
MD5 | 7c5f33887285de6637445797f105e1f0 |
|
BLAKE2b-256 | b1da5a6c51ef36e31f814e5ed42ee3ebf3a6b02df22f01debeb7af1865f5c8ab |