Metadata-Version: 1.1
Name: metaset
Version: 1.4.0
Summary: A container for dicts of sets - alternative to dictset
Home-page: https://github.com/Polyconseil/metaset
Author: Polyconseil
Author-email: opensource+metaset@polyconseil.fr
License: BSD
Download-URL: http://pypi.python.org/pypi/metaset/
Description: metaset
        =======
        
        This package provides a collection that is basically a "dict of sets", named MetaSet.
        
        .. image:: https://travis-ci.org/Polyconseil/metaset.svg?branch=master
            :alt: Build status
        
        .. image:: https://img.shields.io/pypi/pyversions/metaset.svg
            :alt: Supported Python versions
        
        .. image:: https://img.shields.io/pypi/wheel/metaset.svg
            :alt: Wheel status
        
        .. image:: https://img.shields.io/pypi/l/metaset.svg
            :alt: License
        
        Links
        -----
        
        - Package on `PyPI`_: http://pypi.python.org/pypi/metaset/
        - Source on `GitHub <http://github.com/>`_: http://github.com/Polyconseil/metaset/
        - Build on `Travis CI <http://travis-ci.org/>`_: http://travis-ci.org/polyconseil/metaset/
        
        Quickstart
        ----------
        
        Install the package from PyPI_, using pip:
        
        .. _PyPI: http://pypi.python.org/pypi/metaset/
        
        .. code-block:: sh
        
            pip install metaset
        
        
        Or from GitHub:
        
        .. code-block:: sh
        
            git clone git://github.com/Polyconseil/metaset.git
        
        Import it in your code:
        
        .. code-block:: python
        
            >>> from metaset import MetaSet
        
        Usage is quite straight forward,
        basic set operations are supported via the binary operators ``+`` ``-`` ``|`` ``^``.
        
        .. code-block:: python
        
            >>> from pprint import pprint
            >>> pprint(MetaSet(a={1, 2}, b={3}) | MetaSet(b={4}, c={5}))
            {'a': {1, 2}, 'b': {3, 4}, 'c': {5}}
        
        Django Postgres
        ---------------
        
        A custom Django field is available.
        It is quite straightforward:
        
        .. code-block:: python
        
            >>> from metaset.django_field import MetaSetField
            >>> from django.db import models        # doctest: +SKIP
        
            >>> class MyModel(models.Model):        # doctest: +SKIP
                    mset = MetaSetField()           # doctest: +SKIP
        
        The following versions of Python and Django are supported:
        
        - Python 2.7, 3.6, 3.7 and 3.8;
        - Django 1.11, 2.0, 2.1, 2.2, 3.0 and 3.1.
        
        
        Detailed considerations
        -----------------------
        
        They are two ways to consider the "dict of sets" notion,
        differing on how you handle the empty values for keys.
        
        The easiest idea is to consider that a key with no content is non-existent.
        This is how the dictset_ package is implemented.
        
        In this alternative implementation,
        we chose to keep the empty keys as meaningful elements,
        allowing for smart unions and intersections.
        
        .. code-block:: python
        
            >>> pprint(MetaSet(a={1}) | MetaSet(a={2}, b=set()))
            {'a': {1, 2}, 'b': set()}
        
            >>> MetaSet(a={1}) & MetaSet(a={2}, b={3})
            {'a': set()}
        
        So, beware of how empty-keys are handled,
        and consider using dictset_ if it is a better match for your use case.
        The behavior for subtraction and symmetric difference,
        although sound on a mathematical point of view, may not be what you want.
        
        .. code-block:: python
        
            >>> MetaSet(a={1}) - MetaSet(a={1})
            {'a': set()}
        
            >>> MetaSet(a={1}) ^ MetaSet(a={1})
            {'a': set()}
        
        .. _dictset: https://code.google.com/archive/p/dictset/
        
Keywords: metaset,dictset,set,container
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
