{"author":"Haak Saxberg","author_email":"haak.erling@gmail.com","bugtrack_url":null,"classifiers":["License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)","Operating System :: OS Independent","Programming Language :: Python :: 3","Topic :: Software Development :: Libraries"],"description":"Utils\n=====\n\n.. image:: https://travis-ci.org/haaksmash/pyutils.svg?branch=master\n :target: https://travis-ci.org/haaksmash/pyutils\n\nSometimes you write a function over and over again; sometimes you look up at\nthe ceiling and ask \"why, Guido, why isn't this included in the standard\nlibrary?\"\n\nWell, we perhaps can't answer that question. But we can collect those functions\ninto a centralized place!\n\nProvided things\n+++++++++++++++\n\nUtils is broken up into broad swathes of functionality, to ease the task of\nremembering where exactly something lives.\n\nenum\n----\n\nPython doesn't have a built-in way to define an enum, so this module provides (what I think) is a pretty clean way to go about them.\n\n.. code-block:: python\n\n from utils import enum\n\n class Colors(enum.Enum):\n RED = 0\n GREEN = 1\n\n # Defining an Enum class allows you to specify a few\n # things about the way it's going to behave.\n class Options:\n frozen = True # can't change attributes\n strict = True # can only compare to itself; i.e., Colors.RED == Animals.COW\n # will raise an exception.\n\n # or use the enum factory (no Options, though)\n ColorsAlso = enum.enum(\"RED\", \"GREEN\")\n\nOnce defined, use is straightforward:\n\n.. code-block:: python\n\n >>> Colors\n \n >>> Colors.RED\n \n >>> Colors.RED == 0\n True\n >>> Colors.RED == Colors.RED\n True\n >>> Colors.RED = 2\n Traceback (most recent call last):\n File \"\", line 1, in \n File \"utils/enum.py\", line 114, in __setattr__\n raise TypeError(\"can't set attributes on a frozen enum\")\n TypeError: can't set attributes on a frozen enum\n\nmath\n----\n\nCurrently only has the multiplicative analogue of the built-in ``sum``.\n\ndicts\n-----\n\nintersections, differences, winnowing, a few specialized dicts...\n\nlists\n-----\n\nflatten and unlisting. also ``flat_map``!\n\nbools\n-----\n\ncurrently only provides an ``xor`` function.\n\ndates\n-----\n\nMostly cool for the ``TimePeriod`` classes:\n\n.. code-block:: python\n\n >>> from datetime import date # will also work with datetimes\n >>> time_period = TimePeriod(date(2013, 5, 10), date(2013, 8, 11))\n >>> time_period\n \n >>> date(2013, 6, 12) in time_period\n True\n >>> other_time_period = TimePeriod(date(2013, 6, 1), date(2013, 6, 30))\n >>> other_time_period in time_period\n True\n >>> another_time_period = TimePeriod(date(2013, 8, 1), date(2013, 8, 30))\n >>> time_period.overlaps(another_time_period)\n True\n >>> TimePeriod.get_containing_period(time_period, another_time_period)\n \n\n\nand so on and so forth. There's also a ``DiscontinousTimePeriod`` class, which\nstores a collection of TimePeriods.\n\nThere's also helper functions for common operations like ``days_ahead`` and\n``days_ago``, which pretty much do what they say on the tin.\n\nobjects\n-------\n\nprovides ``get_attr``, which is really just a convenient way to do deep ``getattr`` chaining:\n\n.. code-block:: python\n\n >>> get_attr(complicated, 'this.is.a.deep.string', default=None)\n \"the deep string\" # or None, if anything in the lookup chain didn't exist\n\nThere's also an ``immutable`` utility, which will wrap an object and preven all attribute changes,\nrecursively by default. Any attempt to set attributes on the wrapped object will raise an ``AttributeError``:\n\n.. code-block:: python\n\n >>> imm = immutable(something)\n >>> imm\n >\n >>> imm.red\n >\n >>> imm.red = SomethingElse('blue')\n # ...\n AttributeError: This object has been marked as immutable; you cannot set its attributes.\n >>> something.red = SomethingElse('blue')\n >>> imm.red\n >\n\nYou can toggle the recursive immutability by specifying the 'recursive' flag.\n\nInstallation (via pip)\n++++++++++++++++++++++\n\n pip install utils\n\n","description_content_type":"","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"http://github.com/haaksmash/pyutils","keywords":"","license":"","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"utils","package_url":"https://pypi.org/project/utils/","platform":null,"project_url":"https://pypi.org/project/utils/","project_urls":{"Homepage":"http://github.com/haaksmash/pyutils"},"provides_extra":null,"release_url":"https://pypi.org/project/utils/1.0.2/","requires_dist":null,"requires_python":">=3.6","summary":"A grab-bag of utility functions and objects","version":"1.0.2","yanked":false,"yanked_reason":null}

Package search

utils

project_urls

Dependencies

All package metadata

Releases