{"author":"Ionel Cristian Mărieș","author_email":"contact@ionelmc.ro","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: BSD License","Operating System :: Microsoft :: Windows","Operating System :: POSIX","Operating System :: Unix","Programming Language :: Python","Programming Language :: Python :: 2.6","Programming Language :: Python :: 2.7","Programming Language :: Python :: 3","Programming Language :: Python :: 3.3","Programming Language :: Python :: 3.4","Programming Language :: Python :: 3.5","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Utilities"],"description":"======\nFields\n======\n\n.. list-table::\n :stub-columns: 1\n\n * - docs\n - |docs|\n * - tests\n - | |travis| |appveyor| |requires|\n | |coveralls| |codecov|\n | |landscape| |scrutinizer| |codacy| |codeclimate|\n * - package\n - |version| |downloads| |wheel| |supported-versions| |supported-implementations|\n\n.. |docs| image:: https://readthedocs.org/projects/python-fields/badge/?style=flat\n :target: https://readthedocs.org/projects/python-fields\n :alt: Documentation Status\n\n.. |travis| image:: https://travis-ci.org/ionelmc/python-fields.svg?branch=master\n :alt: Travis-CI Build Status\n :target: https://travis-ci.org/ionelmc/python-fields\n\n.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/ionelmc/python-fields?branch=master&svg=true\n :alt: AppVeyor Build Status\n :target: https://ci.appveyor.com/project/ionelmc/python-fields\n\n.. |requires| image:: https://requires.io/github/ionelmc/python-fields/requirements.svg?branch=master\n :alt: Requirements Status\n :target: https://requires.io/github/ionelmc/python-fields/requirements/?branch=master\n\n.. |coveralls| image:: https://coveralls.io/repos/ionelmc/python-fields/badge.svg?branch=master&service=github\n :alt: Coverage Status\n :target: https://coveralls.io/r/ionelmc/python-fields\n\n.. |codecov| image:: https://codecov.io/github/ionelmc/python-fields/coverage.svg?branch=master\n :alt: Coverage Status\n :target: https://codecov.io/github/ionelmc/python-fields\n\n.. |landscape| image:: https://landscape.io/github/ionelmc/python-fields/master/landscape.svg?style=flat\n :target: https://landscape.io/github/ionelmc/python-fields/master\n :alt: Code Quality Status\n\n.. |codacy| image:: https://img.shields.io/codacy/REPLACE_WITH_PROJECT_ID.svg?style=flat\n :target: https://www.codacy.com/app/ionelmc/python-fields\n :alt: Codacy Code Quality Status\n\n.. |codeclimate| image:: https://codeclimate.com/github/ionelmc/python-fields/badges/gpa.svg\n :target: https://codeclimate.com/github/ionelmc/python-fields\n :alt: CodeClimate Quality Status\n.. |version| image:: https://img.shields.io/pypi/v/fields.svg?style=flat\n :alt: PyPI Package latest release\n :target: https://pypi.python.org/pypi/fields\n\n.. |downloads| image:: https://img.shields.io/pypi/dm/fields.svg?style=flat\n :alt: PyPI Package monthly downloads\n :target: https://pypi.python.org/pypi/fields\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/fields.svg?style=flat\n :alt: PyPI Wheel\n :target: https://pypi.python.org/pypi/fields\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/fields.svg?style=flat\n :alt: Supported versions\n :target: https://pypi.python.org/pypi/fields\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/fields.svg?style=flat\n :alt: Supported implementations\n :target: https://pypi.python.org/pypi/fields\n\n.. |scrutinizer| image:: https://img.shields.io/scrutinizer/g/ionelmc/python-fields/master.svg?style=flat\n :alt: Scrutinizer Status\n :target: https://scrutinizer-ci.com/g/ionelmc/python-fields/\n\nContainer class boilerplate killer.\n\nFeatures:\n\n* Human-readable ``__repr__``\n* Complete set of comparison methods\n* Keyword and positional argument support. Works like a normal class - you can override just about anything in the\n subclass (eg: a custom ``__init__``). In contrast, `hynek/characteristic `_\n forces different call schematics and calls your ``__init__`` with different arguments.\n\n\nInstallation\n============\n\n::\n\n pip install fields\n\nUsage & examples\n================\n\nA class that has 2 attributes, ``name`` and ``size``:\n\n.. code:: pycon\n\n >>> from fields import Fields\n >>> class Pizza(Fields.name.size):\n ... pass\n ...\n >>> p = Pizza(\"Pepperoni\", \"large\")\n >>> p\n Pizza(name='Pepperoni', size='large')\n >>> p.size\n 'large'\n >>> p.name\n 'Pepperoni'\n\nYou can also use keyword arguments:\n\n.. code:: pycon\n\n >>> Pizza(size=\"large\", name=\"Pepperoni\")\n Pizza(name='Pepperoni', size='large')\n\nYou can have as many attributes as you want:\n\n.. code:: pycon\n\n >>> class Pizza(Fields.name.ingredients.crust.size):\n ... pass\n ...\n >>> Pizza(\"Funghi\", [\"mushrooms\", \"mozarella\"], \"thin\", \"large\")\n Pizza(name='Funghi', ingredients=['mushrooms', 'mozarella'], crust='thin', size='large')\n\n\nA class that has one required attribute ``value`` and two attributes (``left`` and ``right``) with default value\n``None``:\n\n.. code:: pycon\n\n >>> class Node(Fields.value.left[None].right[None]):\n ... pass\n ...\n >>> Node(1, Node(2), Node(3, Node(4)))\n Node(value=1, left=Node(value=2, left=None, right=None), right=Node(value=3, left=Node(value=4, left=None, right=None), right=None))\n >>> Node(1, right=Node(2))\n Node(value=1, left=None, right=Node(value=2, left=None, right=None))\n\nYou can also use it *inline*:\n\n.. code:: pycon\n\n >>> Fields.name.size(\"Pepperoni\", \"large\")\n FieldsBase(name='Pepperoni', size='large')\n\nWant tuples?\n------------\n\nAn alternative to ``namedtuple``:\n\n.. code:: python\n\n >>> from fields import Tuple\n >>> class Pair(Tuple.a.b):\n ... pass\n ...\n >>> issubclass(Pair, tuple)\n True\n >>> p = Pair(1, 2)\n >>> p.a\n 1\n >>> p.b\n 2\n >>> tuple(p)\n (1, 2)\n >>> a, b = p\n >>> a\n 1\n >>> b\n 2\n\nTuples are *fast*!\n\n::\n\n benchmark: 9 tests, min 5 rounds (of min 25.00us), 1.00s max time, timer: time.perf_counter\n\n Name (time in us) Min Max Mean StdDev Rounds Iterations\n --------------------------------------------------------------------------------------\n test_characteristic 6.0100 1218.4800 11.7102 34.3158 15899 10\n test_fields 6.8000 1850.5250 9.8448 33.8487 5535 4\n test_slots_fields 6.3500 721.0300 8.6120 14.8090 15198 10\n test_super_dumb 7.0111 1289.6667 11.6881 31.6012 15244 9\n test_dumb 3.7556 673.8444 5.8010 15.0514 14246 18\n test_tuple 3.1750 478.7750 5.1974 9.1878 14642 12\n test_namedtuple 3.2778 538.1111 5.0403 9.9177 14105 9\n test_attrs_decorated_class 4.2062 540.5125 5.3618 11.6708 14266 16\n test_attrs_class 3.7889 316.1056 4.7731 6.0656 14026 18\n --------------------------------------------------------------------------------------\n\nDocumentation\n=============\n\nhttps://python-fields.readthedocs.org/\n\nDevelopment\n===========\n\nTo run all the tests run ``tox`` in your shell (``pip install tox`` if you don't have it)::\n\n tox\n\nFAQ\n===\n\nWhy should I use this?\n----------------------\n\nIt's less to type, why have quotes around when the names need to be valid symbols anyway. In fact, this is one of the\nshortest forms possible to specify a container with fields.\n\nBut you're abusing a very well known syntax. You're using attribute access instead of a list of strings. Why?\n--------------------------------------------------------------------------------------------------------------\n\nSymbols should be symbols. Why validate strings so they are valid symbols when you can avoid that? Just use symbols.\nSave on both typing and validation code.\n\nThe use of language constructs is not that surprising or confusing in the sense that semantics precede conventional\nsyntax use. For example, if we have ``class Person(Fields.first_name.last_name.height.weight): pass`` then it's going to\nbe clear we're talking about a *Person* object with *first_name*, *last_name*, *height* and *width* fields: the words\nhave clear meaning.\n\nAgain, you should not name your variables as `f1`, `f2` or any other non-semantic symbols anyway.\n\nSemantics precede syntax: it's like looking at a cake resembling a dog, you won't expect the cake to bark and run\naround.\n\n\n\nIs this stable? Is it tested?\n-------------------------------\n\nYes. Mercilessly tested on `Travis `_ and `AppVeyor\n`_.\n\nIs the API stable?\n-------------------\n\nYes, ofcourse.\n\nWhy not ``namedtuple``?\n------------------------\n\nIt's ugly, repetivive and unflexible. Compare this:\n\n.. code:: python\n\n >>> from collections import namedtuple\n >>> class MyContainer(namedtuple(\"MyContainer\", [\"field1\", \"field2\"])):\n ... pass\n >>> MyContainer(1, 2)\n MyContainer(field1=1, field2=2)\n\nTo this:\n\n.. code:: python\n\n >>> class MyContainer(Tuple.field1.field2):\n ... pass\n >>> MyContainer(1, 2)\n MyContainer(field1=1, field2=2)\n\nWhy not ``characteristic``?\n----------------------------\n\nUgly, inconsistent - you don't own the class:\n\n Lets try this:\n\n .. code:: python\n\n >>> import characteristic\n >>> @characteristic.attributes([\"field1\", \"field2\"])\n ... class MyContainer(object):\n ... def __init__(self, a, b):\n ... if a > b:\n ... raise ValueError(\"Expected %s < %s\" % (a, b))\n >>> MyContainer(1, 2)\n Traceback (most recent call last):\n ...\n ValueError: Missing keyword value for 'field1'.\n\n WHAT !? Ok, lets write some more code:\n\n .. code:: python\n\n >>> MyContainer(field1=1, field2=2)\n Traceback (most recent call last):\n ...\n TypeError: __init__() ... arguments...\n\n This is bananas. You have to write your class *around* these quirks.\n\nLets try this:\n\n.. code:: python\n\n >>> class MyContainer(Fields.field1.field2):\n ... def __init__(self, a, b):\n ... if a > b:\n ... raise ValueError(\"Expected %s < %s\" % (a, b))\n ... super(MyContainer, self).__init__(a, b)\n\nJust like a normal class, works as expected:\n\n.. code:: python\n\n >>> MyContainer(1, 2)\n MyContainer(field1=1, field2=2)\n\nWhy not ``attrs``?\n------------------\n\nNow this is a very difficult question.\n\nConsider this typical use-case::\n\n.. sourcecode:: pycon\n\n >>> import attr\n >>> @attr.s\n ... class Point(object):\n ... x = attr.ib()\n ... y = attr.ib()\n\nWorth noting:\n\n* attrs_ is faster because it doesn't allow your class to be\n used as a mixin (it doesn't do any ``super(cls, self).__init__(...)`` for you).\n* the typical use-case doesn't allow you to have a custom ``__init__``. If you define a custom\n ``__init__``, it will get overridden by the one attrs_ generates.\n* It works better with IDEs and source code analysis tools because of the\n attributes defined on the class.\n\nAll in all, attrs_ is a fast and minimal container library with no support for\nsubclasses. Definitely worth considering.\n\n.. _attrs: `_.\n\nTestimonials\n============\n\n..\n\n Diabolical. Can't be unseen.\n\n -- `David Beazley `_\n\n..\n\n I think that's the saddest a single line of python has ever made me.\n\n -- Someone on IRC (#python)\n\n..\n\n Don't speak around saying that I like it.\n\n -- A PyPy contributor\n\n..\n\n Fields is completey bat-shit insane, but kind of cool.\n\n -- Someone on IRC (#python)\n\n..\n\n WHAT?!?!\n\n -- Unsuspecting victim at EuroPython 2015\n\n.. \n\n I don't think it should work ...\n\n -- Unsuspecting victim at EuroPython 2015\n\n..\n\n Is it some Ruby thing?\n\n -- Unsuspecting victim at EuroPython 2015\n\n..\n\n Are Python programmers that lazy?\n\n -- Some Java developer\n\n..\n\n I'm going to use this in my next project. You're a terrible person.\n\n -- `Isaac Dickinson `_\n\nApologies\n=========\n\nI tried my best at `EuroPython `_ ...\n\n\nChangelog\n=========\n\n5.0.0 (2016-04-13)\n------------------\n\n* Added the ``fields.InheritableFields`` base. It allows subclassing and it's intended for multiple inheritance scenarios. Yes, \n yes, this enables lots pain and suffering, but some people just like it that way.\n* Simplified the interfaces for the builtin sealers (the required argument is gone as it was redundant, and the remaining \n arguments are swapped). Now they must be a function that take just two arguments: ``fields, defaults``.\n\n4.0.0 (2016-01-28)\n------------------\n\n* Added ``__all__`` and ``factory`` conveniences. Removed ``fields.Factory`` from the public API since it need some special\n care with it's use (it's a damn metaclass after all).\n* Added ``make_init_func`` into public API for advanced uses (combine with ``factory`` and ``class_sealer``).\n\n3.0.0 (2015-10-04)\n------------------\n\n* Disallowed creating containers with fields with \"dunder\" names. E.g.: ``class Foo(Fields.__foo__):`` is disallowed.\n\n2.4.0 (2015-06-13)\n------------------\n\n* Similarly to ``fields.Fields``, added three new bases:\n\n * ``fields.BareFields`` (implements ``__init__``).\n * ``fields.ComparableMixin`` (implements ``__eq__``, ``__ne__``, ``__lt__``, ``__gt__``, ``__le__``, ``__ge__`` and ``__hash__``).\n * ``fields.PrintableMixin`` (implements ``__repr__``).\n\n* Improved reference section in the docs.\n* Added ``fields.ConvertibleFields`` and ``fields.ConvertibleMixin``. They have two convenience properties: ``as_dict`` and `as_tuple``.\n\n2.3.0 (2015-01-20)\n------------------\n\n* Allowed overriding ``__slots__`` in ``SlotsFields`` subclasses.\n\n2.2.0 (2015-01-19)\n------------------\n\n* Added ``make_init_func`` as an optional argument to ``class_sealer``. Rename the ``__base__`` option to just ``base``.\n\n2.1.1 (2015-01-19)\n------------------\n\n* Removed bogus ``console_scripts`` entrypoint.\n\n2.1.0 (2015-01-09)\n------------------\n\n* Added ``SlotsFields`` (same as ``Fields`` but automatically adds ``__slots__`` for memory efficiency on CPython).\n* Added support for default argument to Tuple.\n\n2.0.0 (2014-10-16)\n------------------\n\n* Made the __init__ in the FieldsBase way faster (used for ``fields.Fields``).\n* Moved ``RegexValidate`` in ``fields.extras``.\n\n1.0.0 (2014-10-05)\n------------------\n\n* Lots of internal changes, the metaclass is not created in a closure anymore. No more closures.\n* Added ``RegexValidate`` container creator (should be taken as an example on using the Factory metaclass).\n* Added support for using multiple containers as baseclasses.\n* Added a ``super()`` `sink` so that ``super().__init__(*args, **kwargs)`` always works. Everything inherits from a\n baseclass that has an ``__init__`` that can take any argument (unlike ``object.__init__``). This allows for flexible\n usage.\n* Added validation so that you can't use conflicting field layout when using multiple containers as the baseclass.\n* Changed the __init__ function in the class container so it works like a python function w.r.t. positional and keyword\n arguments. Example: ``class MyContainer(Fields.a.b.c[1].d[2])`` will function the same way as ``def func(a, b, c=1,\n d=2)`` would when arguments are passed in. You can now use ``MyContainer(1, 2, 3, 4)`` (everything positional) or\n ``MyContainer(1, 2, 3, d=4)`` (mixed).\n\n0.3.0 (2014-07-19)\n------------------\n\n* Corrected string repr.\n\n0.2.0 (2014-06-28)\n------------------\n\n* Lots of breaking changes. Switched from __call__ to __getitem__ for default value assignment.\n\n0.1.0 (2014-06-27)\n------------------\n\n* Alpha release.","description_content_type":null,"docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/ionelmc/python-fields","keywords":"container,fields,object,class,boilerplate","license":"BSD","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"fields","package_url":"https://pypi.org/project/fields/","platform":"UNKNOWN","project_url":"https://pypi.org/project/fields/","project_urls":{"Homepage":"https://github.com/ionelmc/python-fields"},"provides_extra":null,"release_url":"https://pypi.org/project/fields/5.0.0/","requires_dist":null,"requires_python":"","summary":"Container class boilerplate killer.","version":"5.0.0","yanked":false,"yanked_reason":null}

Package search

fields

project_urls

Dependencies

All package metadata

Releases