Skip to content

Latest commit

 

History

History
204 lines (125 loc) · 5.31 KB

contribution.rst

File metadata and controls

204 lines (125 loc) · 5.31 KB
tocdepth:2

Contributor guide

Development environment

If you’re reading this, you’re probably interested in contributing to py7zr. Thank you very much! The purpose of this guide is to get you to the point where you can make improvements to the py7zr and share them with the rest of the team.

Setup Python

The py7zr is written in the Python programming language. Python installation for various platforms with various ways. You need to install Python environment which support pip command. Venv/Virtualenv is recommended for development.

We have a test suite with python 3.9, 3.10, 3.11, 3.12, 3.13, and pypy3. If you want to run all the test with these versions and variant on your local, you should install these versions. You can run test with CI environment on Github actions.

Get Early Feedback

If you are contributing, do not feel the need to sit on your contribution until it is perfectly polished and complete. It helps everyone involved for you to seek feedback as early as you possibly can. Submitting an early, unfinished version of your contribution for feedback in no way prejudices your chances of getting that contribution accepted, and can save you from putting a lot of work into a contribution that is not suitable for the project.

Code Contributions

Steps submitting code

When contributing code, you’ll want to follow this checklist:

  1. Fork the repository on GitHub.
  2. Run the tox tests to confirm they all pass on your system. If they don’t, you’ll need to investigate why they fail. If you’re unable to diagnose this yourself, raise it as a bug report.
  3. Write tests that demonstrate your bug or feature. Ensure that they fail.
  4. Make your change.
  5. Run the entire test suite again using tox, confirming that all tests pass including the ones you just added.
  6. Send a GitHub Pull Request to the main repository’s master branch. GitHub Pull Requests are the expected method of code collaboration on this project.

Code review

Contribution will not be merged until they have been code reviewed. There are limited reviewer in the team, reviews from other contributors are also welcome. You should implemented a review feedback unless you strongly object to it.

Code style

The py7zr uses the PEP8 code style. In addition to the standard PEP8, we have an extended guidelines

  • line length should not exceed 125 characters.
  • It also use MyPy static type check enforcement.

Profiling

CPU and memory profiling

Run-time memory errors and leaks are among the most difficult errors to locate and the most important to correct. Memory profiling is used to detect memory leaks or unwanted memory usages.

It is also a difficult work to improve performance. CPU profiling help us to understand where is a hot spot of execution of a program.

mprofile

mprofile is a tool to do a memory profiling task for python. py7zr project has a test configuration for the memory profiling.

env PYTEST_ADDOPTS=--run-slow tox -e mprof

This example run all the test cases includes conditions which requires running duration.

After running test, you can find a chart in project root. memory-profiile.png and raw data as mprofile_yyyyMMddhhmmss.dat

Class and module design

The py7zr take class design that categorized into several sub modules to reflect its role.

The main class is py7zr.SevenZipFile() class which provide API for library users. The main internal classes are in the submodule py7zr.archiveinfo, which takes class structure as same as .7z file format structure.

Another important submodule is py7zr.compressor module that hold all related compression and encryption proxy classes for corresponding libraries to convert various interfaces into common ISevenZipCompressor() and ISevenZipDecompressor() interface.

All UI related classes and functions are separated from core modules. cli submodule is a place for command line functions and pretty printings.

.. graphviz:: diagrams/packages.dot

Here is a whole classes diagram. There are part by part descriptions at Next sections.

.. graphviz:: diagrams/classes.dot

Header classes

Header related classes are in py7zr.archiveinfo submodule.

.. graphviz:: diagrams/header_classes.dot

Compressor classes

There are compression related classes in py7zr.compressor submodule.

.. graphviz:: diagrams/compressor_classes.dot

IO Abstraction classes

There are two IO abstraction classes to provide Mem API and check method.

.. graphviz:: diagrams/abstractio.dot

Callback classes

Here is a callback interface class. ExtractCallback class is a concrete class used in CLI.

.. graphviz:: diagrams/callbacks.dot

Classes details

Here is a detailed interface documentation for implementer.

ArchiveFile Objects

.. automodule:: py7zr.py7zr
   :members:

archiveinfo module

.. automodule:: py7zr.archiveinfo
   :members:

compressor module

.. automodule:: py7zr.compressor
   :members:

helpers module

.. automodule:: py7zr.helpers
   :members: