معرفی شرکت ها

class-doc-0.2.6

Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
0.2.6
0.2.5
0.2.0b0
0.1.1
0.1.0
0.2.6
0.2.5
0.2.0b0
0.1.1
0.1.0

توضیحات

Extract attributes docstrings defined in various ways
ویژگی مقدار
سیستم عامل -
نام فایل class-doc-0.2.6
نام class-doc
نسخه کتابخانه 0.2.6
نگهدارنده []
ایمیل نگهدارنده []
نویسنده Daniel Daniels
ایمیل نویسنده danields761@gmail.com
آدرس صفحه اصلی https://github.com/danields761/class-doc
آدرس اینترنتی https://pypi.org/project/class-doc/
مجوز MIT
# Class doc Small set of helpers aimed to extract class attributes documentation from the class definition. This stuff tries to mimic [sphinx-autodoc behaviour](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoattribute) as closely as possible (except instance attributes defined inside `__init__` function). The main advantage of this project over [sphinx-autodoc] is that it is lightweight single-purpose dependency, while *autodoc* just a small part of really heavy project. ## Installation This package is available on [PyPI] ```bash pip install class-doc ``` ## Examples Shamely stolen from [sphinx-autodoc] docs ```python class Foo: """Docstring for class Foo.""" #: Doc comment for class attribute Foo.bar. #: It can have multiple lines. bar = 1 flox = 1.5 #: Doc comment for Foo.flox. One line only. baz = 2 """Docstring for class attribute Foo.baz.""" baf = 3 """ Even multiline docstrings handled properly """ import class_doc assert class_doc.extract_docs_from_cls_obj(Foo) == { "bar": ["Doc comment for class attribute Foo.bar.", "It can have multiple lines."], "flox": ["Doc comment for Foo.flox. One line only."], "baz": ["Docstring for class attribute Foo.baz."], "baf": ["Even", "multiline", "docstrings", "handled", "properly"] } ``` ## Development setup Project requires [Poetry] for development setup. * If you aren't have it already ```sh pip install poetry ``` * Install project dependencies ```sh poetry install ``` * Run tests ```sh poetry run pytest . ``` * Great, all works! <!-- Links --> [PyPI]: http://pypi.org [Poetry]: https://poetry.eustace.io/ [sphinx-autodoc]: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoattribute


نیازمندی

مقدار نام
>=5.0.0 more-itertools


زبان مورد نیاز

مقدار نام
>=3.6,<4.0 Python


نحوه نصب


نصب پکیج whl class-doc-0.2.6:

    pip install class-doc-0.2.6.whl


نصب پکیج tar.gz class-doc-0.2.6:

    pip install class-doc-0.2.6.tar.gz