معرفی شرکت ها
examples-1.0.2
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Tests and Documentation Done by Example.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | examples-1.0.2 |
| نام | examples |
| نسخه کتابخانه | 1.0.2 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Timothy Crosley |
| ایمیل نویسنده | timothy.crosley@gmail.com |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/examples/ |
| مجوز | MIT |
[](https://timothycrosley.github.io/examples/)
_________________
[](http://badge.fury.io/py/examples)
[](https://travis-ci.org/timothycrosley/examples)
[](https://codecov.io/gh/timothycrosley/examples)
[](https://gitter.im/timothycrosley/examples?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://pypi.python.org/pypi/examples/)
[](https://pepy.tech/project/examples)
_________________
[Read Latest Documentation](https://timothycrosley.github.io/examples/) - [Browse GitHub Code Repository](https://github.com/timothycrosley/examples/)
_________________
**eXamples** (AKA: xamples for SEO) is a Python3 library enabling interactable, self-documenting, and self-verifying examples. These examples are attached directly to Python functions using decorators or via separate `MODULE_examples.py` source files.
[](https://raw.githubusercontent.com/timothycrosley/examples/master/art/example.gif)
Key Features:
* **Simple and Obvious API**: Add `@examples.example(*args, **kwargs)` decorators for each example you want to add to a function.
* **Auto Documenting**: Examples, by default, get added to your functions docstring viewable both in interactive interpreters and when using [portray](https://timothycrosley.github.io/portray/) or [pdocs](https://timothycrosley.github.io/pdocs/).
* **Signature Validating**: All examples can easily be checked to ensure they match the function signature (and type annotations!) with a single call (`examples.verify_all_signatures()`).
* **Act as Tests**: Examples act as additional test cases, that can easily be verified using a single test case in your favorite test runner: (`examples.test_all_examples()`).
* **Async Compatibility**: Examples can be attached and tested as easily against async functions as non-async ones.
What's Missing:
* **Class Support**: Currently examples can only be attached to individual functions. Class and method support is planned for a future release.
## Quick Start
The following guides should get you up and running using eXamples in no time.
1. [Installation](https://timothycrosley.github.io/examples/docs/quick_start/1.-installation/) - TL;DR: Run `pip3 install examples` within your projects virtual environment.
2. [Adding Examples](https://timothycrosley.github.io/examples/docs/quick_start/2.-adding-examples/) -
TL;DR: Add example decorators that represent each of your examples:
# my_module_with_examples.py
from examples import example
@example(1, number_2=1, _example_returns=2)
def add(number_1: int, number_2: int) -> int:
return number_1 + number_2
3. [Verify and Test Examples](https://timothycrosley.github.io/examples/docs/quick_start/3.-testing-examples/) -
TL;DR: run `examples.verify_and_test_examples` within your projects test cases.
# test_my_module_with_examples.py
from examples import verify_and_test_examples
import my_module_with_examples
def test_examples_verifying_signature():
verify_and_test_examples(my_module_with_examples)
4. Introspect Examples -
import examples
from my_module_with_examples import add
examples.get_examples(add)[0].use() == 2
## Why Create Examples?
I've always wanted a way to attach examples to functions in a way that would be re-useable for documentation, testing, and API proposes.
Just like moving Python parameter types from comments into type annotations has made them more broadly useful, I hope examples can do the same for example calls.
I hope you too find `eXamples` useful!
~Timothy Crosley
نیازمندی
| مقدار | نام |
|---|---|
| >=0.32.2 | pydantic |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6,<4.0 | Python |
نحوه نصب
نصب پکیج whl examples-1.0.2:
pip install examples-1.0.2.whl
نصب پکیج tar.gz examples-1.0.2:
pip install examples-1.0.2.tar.gz