Skip to main content

Decorators for adding memoization.

Project description

memoir

In what follows

  • python is an alias for python3.5 or any later version (python3.6 and so on),
  • pypy is an alias for pypy3.5 or any later version (pypy3.6 and so on).

Installation

Install the latest pip & setuptools packages versions:

  • with CPython
    python -m pip install --upgrade pip setuptools
    
  • with PyPy
    pypy -m pip install --upgrade pip setuptools
    

User

Download and install the latest stable version from PyPI repository:

  • with CPython
    python -m pip install --upgrade memoir
    
  • with PyPy
    pypy -m pip install --upgrade memoir
    

Developer

Download the latest version from GitHub repository

git clone https://github.com/lycantropos/memoir.git
cd memoir

Install:

  • with CPython
    python setup.py install
    
  • with PyPy
    pypy setup.py install
    

Usage

Let's suppose we are defining a class with expensive read-only property which can be calculated once and reused afterwards.

Common way of solving this is by introducing private'ish attribute like

>>> class Example:
...     @property
...     def expensive_property(self):
...         try:
...             result = self._expensive_property
...         except AttributeError:
...             result = do_expensive_calculations(...)
...             self._expensive_property = result
...         return result

this works fine, but each such property

  • introduces an extra attribute,
  • requires a lot of boilerplate code.

If we have

class we can implement it like

>>> from memoir import cached
>>> class Example:
...     @cached.property_
...     def expensive_property(self):
...         return do_expensive_calculations(...)

Development

Bumping version

Preparation

Install bump2version.

Pre-release

Choose which version number category to bump following semver specification.

Test bumping version

bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.

Release

Test bumping version

bump2version --dry-run --verbose --tag release

Bump version

bump2version --verbose --tag release

This will set version to major.minor.patch and add Git tag.

Notes

To avoid inconsistency between branches and pull requests, bumping version should be merged into master branch as separate pull request.

Running tests

Plain:

  • with CPython
    python setup.py test
    
  • with PyPy
    pypy setup.py test
    

Inside Docker container:

  • with CPython
    docker-compose --file docker-compose.cpython.yml up
    
  • with PyPy
    docker-compose --file docker-compose.pypy.yml up
    

Bash script (e.g. can be used in Git hooks):

  • with CPython

    ./run-tests.sh
    

    or

    ./run-tests.sh cpython
    
  • with PyPy

    ./run-tests.sh pypy
    

PowerShell script (e.g. can be used in Git hooks):

  • with CPython
    .\run-tests.ps1
    
    or
    .\run-tests.ps1 cpython
    
  • with PyPy
    .\run-tests.ps1 pypy
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

memoir-0.0.2.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

memoir-0.0.2-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file memoir-0.0.2.tar.gz.

File metadata

  • Download URL: memoir-0.0.2.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.5.4

File hashes

Hashes for memoir-0.0.2.tar.gz
Algorithm Hash digest
SHA256 5da9ac6b3c6a1ca8a2d2cfad34db7c93cdd7af81d8983f37c2ca9e5e49866138
MD5 d5c3bcca90eaf34d24334eba57b4c842
BLAKE2b-256 d0929a202bddc3d128b3f34e241d157d36f726e8a098c7cf8756ededce933b84

See more details on using hashes here.

File details

Details for the file memoir-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: memoir-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.5.4

File hashes

Hashes for memoir-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6711db9f999c7c864732a0b96d8cf759a2ccc8e307c053fba6ccbb124e57360d
MD5 f25e5b2c413050d8082bf3d85aba416a
BLAKE2b-256 386fd1409229c0f176a5ecbc732d9ee8cf4a34fc558dbeb629b443864f79e813

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page