معرفی شرکت ها

تبلیغات ما

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

مشاهده بیشتر

تبلیغات ما

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

مشاهده بیشتر

تبلیغات ما

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

مشاهده بیشتر

تبلیغات ما

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

مشاهده بیشتر

تبلیغات ما

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

مشاهده بیشتر

توضیحات

Parser for Numpy, Sphinx, and Google-style docstrings

ویژگی	مقدار
سیستم عامل	-
نام فایل	docstring-utils-1.0.0
نام	docstring-utils
نسخه کتابخانه	1.0.0
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	Jonah Lawrence
ایمیل نویسنده	jonah@freshidea.com
آدرس صفحه اصلی	https://github.com/DenverCoder1/docstring-utils
آدرس اینترنتی	https://pypi.org/project/docstring-utils/
مجوز	-

# docstring-utils [![build](https://img.shields.io/github/workflow/status/DenverCoder1/docstring-utils/Python%20application/main)](https://github.com/DenverCoder1/docstring-utils/actions/workflows/python-app.yml) [![version](https://img.shields.io/pypi/v/docstring-utils)](https://pypi.org/project/docstring-utils/) [![license](https://img.shields.io/pypi/l/docstring-utils)](https://github.com/DenverCoder1/docstring-utils/blob/main/LICENSE) [![discord](https://img.shields.io/discord/819650821314052106?color=5865F2&logo=discord&logoColor=white "Dev Pro Tips Discussion & Support Server")](https://discord.gg/fPrdqh3Zfu) Simple parser for Numpy, Sphinx, and Google-style docstrings ## 📥 Installation `pip install -U docstring-utils` **Requirements:** `Python 3.7+` ## 🧑‍💻 Usage ### Parse docstring ```py from docstring_utils import parse_docstring def example(arg1: str, arg2: int) -> int: """Example of a Google-style docstring. Args: arg1 (str): Description of `arg1`. arg2 (int): Description of `arg2`. Returns: int: Description of `return` value. """ return 0 result = parse_docstring(example, filter_args=True) print(result.description) # "Example of a Google-style docstring." args = result.args.values() print(args[0].name) # "arg1" print(args[0].description) # "Description of `arg1`." print(args[0].type) # "str" print(result.return_value.type) # "int" print(result.return_value.description) # "Description of `return` value." ``` ## 🧰 Development ### Running tests 1. Install `tox` with the command `pip install -U tox` 2. Run tests with the command `tox` ### Linting Run the following command to lint with flake8 `python setup.py lint` (Note: The exact command may vary depending on your Python version and environment)

نیازمندی

مقدار	نام
<5,>=4.4.0	sphinx
<3,>=2.18.0	sphinx-toolbox
<2,>=1.1.2	sphinxcontrib-trio
==0.2.0	sphinx-book-theme
<1,>=0.6.2	sphinxext-opengraph

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

مقدار	نام
>=3.6	Python

نحوه نصب

نصب پکیج whl docstring-utils-1.0.0:

pip install docstring-utils-1.0.0.whl

نصب پکیج tar.gz docstring-utils-1.0.0:

pip install docstring-utils-1.0.0.tar.gz