Skip to main content

Infix operators for Python

Project description

Latest PyPI version Travis build status

A decorator that allows functions to be used as infix functions.

Infix operators are created and applied as such, and do not stop the function from being called normally:

>>> from infix import shift_infix as infix
...
>>> @infix
... def plus(a, b):
...     return a + b
...
>>> print(40 <<plus>> 2)
42
>>> print(plus(5, 5))
10

Variant syntaxes

Multiple infix syntaxes are provided by the infix module:

>>> @and_infix
... def is_before(a, b):
...     return a < b
...
>>> print(1 &is_before& 5)
True

>>> @or_infix
... def minus(a, b):
...     return a - b
...
>>> print(1 |minus| 2)
-1

>>> @xor_infix
... def until(start, stop):
...     return range(start, stop)
...
>>> print(list(1 ^until^ 10))
[1, 2, 3, 4, 5, 6, 7, 8, 9]

>>> @pow_infix
... def pow(a, b):
...     return a**b
...
>>> print(3 **pow** 2)
9

Custom syntaxes

Python has a large set of operators than could be overridden to provide the infix syntax, so instead of providing them all a custom_infix function is provided. It takes two parameters, the names of the left and right operator functions:

>>> @custom_infix('__rmod__', '__mod__')
... def ate(a, b):
...     return (a == 7 and b == 9)
...
>>> print(7 %ate% 9)
True
>>> print(6 %ate% 7)
False

The left function should be a right operand, and the right functions should be a left operand.

You should be careful to avoid using operands that the objects your functions will take may provide themselves (as the initial right operand is only called if the previous object does not provide for that operand).

Compatibility

Works on all major Python versions (2.6, 2.7, 3.2, 3.3, 3.4).

Tests

The tests in this README files are run using doctest. To run the tests, run ‘’python infix.py’’ - alternatively, use tox to run the tests on all compatible Python versions.

Licence

Copyright (C) 2013 Sam Clements

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

infix-1.1.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

infix-1.1-py2-none-any.whl (6.0 kB view details)

Uploaded Python 2

File details

Details for the file infix-1.1.tar.gz.

File metadata

  • Download URL: infix-1.1.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for infix-1.1.tar.gz
Algorithm Hash digest
SHA256 689d1670a45cb4b8318a8d140c5dc002b457ed53f1693e59ca39b2f314c27e93
MD5 061bd40536bcf4d482ce29fcdea81856
BLAKE2b-256 7c4e8d8879c894b347a79ba4fd461f8bdcc2d0f348d361398c5c604ef19e3817

See more details on using hashes here.

File details

Details for the file infix-1.1-py2-none-any.whl.

File metadata

File hashes

Hashes for infix-1.1-py2-none-any.whl
Algorithm Hash digest
SHA256 8c074b6326e3b06ce5566b96c02b605153a45bf778ac4d887617d619172f7962
MD5 fee056e11a0782ff9fef7d49665d0d48
BLAKE2b-256 2bb45d2089d4d260e84f2a989692873ae0a3b6a1d9bc6b162a005ad04083d1c1

See more details on using hashes here.

Supported by

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