chore: 添加虚拟环境到仓库
- 添加 backend_service/venv 虚拟环境 - 包含所有Python依赖包 - 注意：虚拟环境约393MB，包含12655个文件
This commit is contained in:
@@ -0,0 +1 @@
|
||||
pip
|
||||
@@ -0,0 +1,117 @@
|
||||
Metadata-Version: 2.4
|
||||
Name: docstring_parser
|
||||
Version: 0.17.0
|
||||
Summary: Parse Python docstrings in reST, Google and Numpydoc format
|
||||
Project-URL: homepage, https://github.com/rr-/docstring_parser
|
||||
Project-URL: repository, https://github.com/rr-/docstring_parser
|
||||
Project-URL: changelog, https://github.com/rr-/docstring_parser/blob/master/CHANGELOG.md
|
||||
Author-email: Marcin Kurczewski <dash@wind.garden>
|
||||
License: MIT
|
||||
License-File: LICENSE.md
|
||||
Classifier: Development Status :: 4 - Beta
|
||||
Classifier: Environment :: Other Environment
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: License :: OSI Approved :: MIT License
|
||||
Classifier: Natural Language :: English
|
||||
Classifier: Operating System :: OS Independent
|
||||
Classifier: Programming Language :: Python :: 3.8
|
||||
Classifier: Programming Language :: Python :: 3.9
|
||||
Classifier: Programming Language :: Python :: 3.10
|
||||
Classifier: Programming Language :: Python :: 3.11
|
||||
Classifier: Programming Language :: Python :: 3.12
|
||||
Classifier: Programming Language :: Python :: 3.13
|
||||
Classifier: Topic :: Documentation :: Sphinx
|
||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||||
Classifier: Topic :: Text Processing :: Markup
|
||||
Requires-Python: >=3.8
|
||||
Provides-Extra: dev
|
||||
Requires-Dist: pre-commit>=2.16.0; (python_version >= '3.9') and extra == 'dev'
|
||||
Requires-Dist: pydoctor>=25.4.0; extra == 'dev'
|
||||
Requires-Dist: pytest; extra == 'dev'
|
||||
Provides-Extra: docs
|
||||
Requires-Dist: pydoctor>=25.4.0; extra == 'docs'
|
||||
Provides-Extra: test
|
||||
Requires-Dist: pytest; extra == 'test'
|
||||
Description-Content-Type: text/markdown
|
||||
|
||||
docstring_parser
|
||||
================
|
||||
|
||||
[](https://github.com/rr-/docstring_parser/actions/workflows/build.yml)
|
||||
|
||||
Parse Python docstrings. Currently support ReST, Google, Numpydoc-style and
|
||||
Epydoc docstrings.
|
||||
|
||||
Example usage:
|
||||
|
||||
```python
|
||||
>>> from docstring_parser import parse
|
||||
>>>
|
||||
>>>
|
||||
>>> docstring = parse(
|
||||
... '''
|
||||
... Short description
|
||||
...
|
||||
... Long description spanning multiple lines
|
||||
... - First line
|
||||
... - Second line
|
||||
... - Third line
|
||||
...
|
||||
... :param name: description 1
|
||||
... :param int priority: description 2
|
||||
... :param str sender: description 3
|
||||
... :raises ValueError: if name is invalid
|
||||
... ''')
|
||||
>>>
|
||||
>>> docstring.long_description
|
||||
'Long description spanning multiple lines\n- First line\n- Second line\n- Third line'
|
||||
>>> docstring.params[1].arg_name
|
||||
'priority'
|
||||
>>> docstring.raises[0].type_name
|
||||
'ValueError'
|
||||
```
|
||||
|
||||
Read [API Documentation](https://rr-.github.io/docstring_parser/).
|
||||
|
||||
# Installation
|
||||
|
||||
Installation using pip
|
||||
|
||||
```shell
|
||||
pip install docstring_parser
|
||||
|
||||
# or if you want to install it in a virtual environment
|
||||
|
||||
python -m venv venv # create environment
|
||||
source venv/bin/activate # activate environment
|
||||
python -m pip install docstring_parser
|
||||
```
|
||||
|
||||
Installation using conda
|
||||
|
||||
|
||||
1. Download and install miniconda or anaconda
|
||||
2. Install the package from the conda-forge channel via:
|
||||
- `conda install -c conda-forge docstring_parser`
|
||||
- or create a new conda environment via `conda create -n my-new-environment -c conda-forge docstring_parser`
|
||||
|
||||
|
||||
# Contributing
|
||||
|
||||
To set up the project:
|
||||
```sh
|
||||
git clone https://github.com/rr-/docstring_parser.git
|
||||
cd docstring_parser
|
||||
|
||||
python -m venv venv # create environment
|
||||
source venv/bin/activate # activate environment
|
||||
|
||||
pip install -e ".[dev]" # install as editable
|
||||
pre-commit install # make sure pre-commit is setup
|
||||
```
|
||||
|
||||
To run tests:
|
||||
```
|
||||
source venv/bin/activate
|
||||
pytest
|
||||
```
|
||||
@@ -0,0 +1,42 @@
|
||||
docstring_parser-0.17.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
docstring_parser-0.17.0.dist-info/METADATA,sha256=gbIZ88nEPrD7xSgJvJPgY2Bww7SClG2IunaNdbjPgP0,3499
|
||||
docstring_parser-0.17.0.dist-info/RECORD,,
|
||||
docstring_parser-0.17.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
||||
docstring_parser-0.17.0.dist-info/licenses/LICENSE.md,sha256=3-UUozeuhBer0xqK9we71hcrA-VDC7CD4UWJnql6Puo,1084
|
||||
docstring_parser/__init__.py,sha256=78WKoStdo7zvCcEU1Sm2zLvU_BRGKyTYjlScFEB14nk,695
|
||||
docstring_parser/__pycache__/__init__.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/attrdoc.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/common.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/epydoc.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/google.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/numpydoc.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/parser.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/rest.cpython-313.pyc,,
|
||||
docstring_parser/__pycache__/util.cpython-313.pyc,,
|
||||
docstring_parser/attrdoc.py,sha256=grazLW9kqFIFmvjP9waYtTjgUEurlrzBZBPMED4yRNk,4126
|
||||
docstring_parser/common.py,sha256=Wua16UpvZL8nqmrRMwph2PPNDx774aK3WFnSnjvVPPw,6320
|
||||
docstring_parser/epydoc.py,sha256=6onvURmJ6gSz5DK7r-p7LkiOlSjRQitkI2mNFIHPQQE,8923
|
||||
docstring_parser/google.py,sha256=jhrRS_v8eOVO19ciQ0OZt3AH9LN_2m8XD6YmIRPQ6SQ,13526
|
||||
docstring_parser/numpydoc.py,sha256=m_K2_icSjwzXnx14dDGiL9wxQ7IXnVT4pzQaLbeWTt8,15984
|
||||
docstring_parser/parser.py,sha256=AB-R7X36siUZ1rqRQC3jtZKgAQJnkUGdPDjRJb54y9k,2938
|
||||
docstring_parser/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
|
||||
docstring_parser/rest.py,sha256=CVvGjiXtjteL0DA-Oa2ySbHF91RctX8NggfprEHT990,8289
|
||||
docstring_parser/tests/__init__.py,sha256=6VULghkufHkqtZfyiBamwZQNBA3z7f4TMEcBclUqTKE,34
|
||||
docstring_parser/tests/__pycache__/__init__.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/_pydoctor.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_epydoc.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_google.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_numpydoc.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_parse_from_object.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_parser.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_rest.cpython-313.pyc,,
|
||||
docstring_parser/tests/__pycache__/test_util.cpython-313.pyc,,
|
||||
docstring_parser/tests/_pydoctor.py,sha256=nosAlcm_ovpetXTWnrLewqnP4Ea7pM_xbABAspBivcc,770
|
||||
docstring_parser/tests/test_epydoc.py,sha256=h6aghJc4KAF3sJD5KhwLqTyXTpp5GCXEOFUTuyVLCQo,19097
|
||||
docstring_parser/tests/test_google.py,sha256=oVBWi5qWu0VABXp1XYsSh8merbpR-rcZIAdCsURUrcw,27342
|
||||
docstring_parser/tests/test_numpydoc.py,sha256=qRfcoqwPHPxP83MXAgV1mLgi3Vu4vSb2EgK3SRuj9Uc,28988
|
||||
docstring_parser/tests/test_parse_from_object.py,sha256=n3gHsGJ8zAfqI6-4C_IyX2egrWF_-LSx9Nn59GjvVeE,3824
|
||||
docstring_parser/tests/test_parser.py,sha256=6UuVKFTj7501CzjdA8A-mrpRS63hA8Wor-_H3vsksvo,6700
|
||||
docstring_parser/tests/test_rest.py,sha256=V_-z1pfAxTBabOkP9e3hm_xQGEPyfPxo34b5FyxrnEE,15195
|
||||
docstring_parser/tests/test_util.py,sha256=rN8vMUKfyMmKdDxKV6RrjPXPPQclmX7wcN6aSrj4NFI,1739
|
||||
docstring_parser/util.py,sha256=8VmGXhuMcWkrvtZSSKIhX4cKakJmWIILffY6JBQAiCg,4506
|
||||
@@ -0,0 +1,4 @@
|
||||
Wheel-Version: 1.0
|
||||
Generator: hatchling 1.27.0
|
||||
Root-Is-Purelib: true
|
||||
Tag: py3-none-any
|
||||
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Marcin Kurczewski
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Reference in New Issue
Block a user