https://github.com/smarie/python-autoclass

A python 3 library providing functions and decorators to automatically generate class code, such as constructor body or properties getters/setters along with optional support of validation contracts on the generated setters. Its objective is to reduce the amount of copy/paste code in your classes - and hence to help reducing human mistakes :).
https://github.com/smarie/python-autoclass

attr attribute auto autoargs autoprops boilerplate class code-generator constructor contracts enforce fields getter pep484 properties property runtime-typechecking setter type-hints typechecking

Last synced: about 2 months ago
JSON representation

A python 3 library providing functions and decorators to automatically generate class code, such as constructor body or properties getters/setters along with optional support of validation contracts on the generated setters. Its objective is to reduce the amount of copy/paste code in your classes - and hence to help reducing human mistakes :).

• Host: GitHub
• URL: https://github.com/smarie/python-autoclass
• Owner: smarie
• License: bsd-3-clause
• Created: 2016-12-31T11:21:11.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-04-19T22:19:45.000Z (over 3 years ago)
• Last Synced: 2024-10-11T21:55:11.089Z (2 months ago)
• Topics: attr, attribute, auto, autoargs, autoprops, boilerplate, class, code-generator, constructor, contracts, enforce, fields, getter, pep484, properties, property, runtime-typechecking, setter, type-hints, typechecking
• Language: Python
• Homepage: https://smarie.github.io/python-autoclass/
• Size: 2.86 MB
• Stars: 37
• Watchers: 4
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# python-autoclass

*Write compact python classes*

[![Python versions](https://img.shields.io/pypi/pyversions/autoclass.svg)](https://pypi.python.org/pypi/autoclass/) [![Build Status](https://travis-ci.org/smarie/python-autoclass.svg?branch=master)](https://travis-ci.org/smarie/python-autoclass) [![Tests Status](https://smarie.github.io/python-autoclass/junit/junit-badge.svg?dummy=8484744)](https://smarie.github.io/python-autoclass/junit/report.html) [![codecov](https://codecov.io/gh/smarie/python-autoclass/branch/master/graph/badge.svg)](https://codecov.io/gh/smarie/python-autoclass)

[![Documentation](https://img.shields.io/badge/doc-latest-blue.svg)](https://smarie.github.io/python-autoclass/) [![PyPI](https://img.shields.io/pypi/v/autoclass.svg)](https://pypi.python.org/pypi/autoclass/) [![Downloads](https://pepy.tech/badge/autoclass)](https://pepy.tech/project/autoclass) [![Downloads per week](https://pepy.tech/badge/autoclass/week)](https://pepy.tech/project/autoclass) [![GitHub stars](https://img.shields.io/github/stars/smarie/python-autoclass.svg)](https://github.com/smarie/python-autoclass/stargazers)

**This is the readme for developers.** The documentation for users is available here: [https://smarie.github.io/python-autoclass/](https://smarie.github.io/python-autoclass/)

## Want to contribute ?

Contributions are welcome ! Simply fork this project on github, commit your contributions, and create pull requests.

Here is a non-exhaustive list of interesting open topics: [https://github.com/smarie/python-autoclass/issues](https://github.com/smarie/python-autoclass/issues)

## Running the tests

This project uses `pytest`. 

```bash

pytest -v autoclass/tests/

```

You may need to install requirements for setup beforehand, using 

```bash

pip install -r ci_tools/requirements-test.txt

```

## Packaging

This project uses `setuptools_scm` to synchronise the version number. Therefore the following command should be used for development snapshots as well as official releases: 

```bash

python setup.py egg_info bdist_wheel rotate -m.whl -k3

```

You may need to install requirements for setup beforehand, using 

```bash

pip install -r ci_tools/requirements-setup.txt

```

## Generating the documentation page

This project uses `mkdocs` to generate its documentation page. Therefore building a local copy of the doc page may be done using:

```bash

mkdocs build -f docs/mkdocs.yml

```

You may need to install requirements for doc beforehand, using 

```bash

pip install -r ci_tools/requirements-doc.txt

```

## Generating the test reports

The following commands generate the html test report and the associated badge. 

```bash

pytest --junitxml=junit.xml -v autoclass/tests/

ant -f ci_tools/generate-junit-html.xml

python ci_tools/generate-junit-badge.py

```

### PyPI Releasing memo

This project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:

```bash

twine upload dist/* -r pypitest

twine upload dist/*

```

### Merging pull requests with edits - memo

Ax explained in github ('get commandline instructions'):

```bash

git checkout -b - master

git pull https://github.com//python-autoclass.git  --no-commit --ff-only

```

if the second step does not work, do a normal auto-merge (do not use **rebase**!):

```bash

git pull https://github.com//python-autoclass.git  --no-commit

```

Finally review the changes, possibly perform some modifications, and commit.