Skip to content

Latest commit

 

History

History
167 lines (128 loc) · 5.55 KB

README.rst

File metadata and controls

167 lines (128 loc) · 5.55 KB

HTTP Status

A simple HTTP status code/name/description library for Python.

Uses the six library for Python 2/3 compatability.

Installation

Either install via pip:

$ pip install http_status

Or clone the git repo, and run setup.py:

$ git clone https://github.com/DanielOaks/http_status.git
Cloning into 'http_status'...
[...]
Unpacking objects: 100% (18/18), done.

$ cd http_status/

$ python setup.py build install
running build
[...]
Writing /usr/local/lib/python2.7/site-packages/http_status-0.1.0a-py2.7.egg-info

Usage

Use by itself:

>>> import http_status
>>> http_status.name[302]
'Found'
>>> http_status.description[302]
'URI of this resource has changed, temporarily.'

Use of the Status object:

>>> from http_status import Status
>>> s = Status(403)
>>> s.code
403
>>> s.name
'Forbidden'
>>> s.description
'Client does not have rights to access the content.'

>>> s.code = 405
>>> s.name
'Method Not Allowed'
>>> s.description
'Server has disabled this request method and cannot be used.'

Status() only accepts 'valid' HTTP status codes, ints from 100 to 599 as per RFC. If an invalid code is given, it will throw an InvalidHttpCode exception:

>>> from http_status import Status
>>> s = Status(9999)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/local/lib/python2.7/site-packages/http_status/__init__.py", line 279, in __init__
    self.code = code
  File "/usr/local/lib/python2.7/site-packages/http_status/__init__.py", line 301, in code
    self._code = validate_http_code(http_code, strict=self.strict)
  File "/usr/local/lib/python2.7/site-packages/http_status/__init__.py", line 262, in validate_http_code
    raise InvalidHttpCode('{} is above maximum HTTP status code {}'.format(http_code, maximum))
http_status.InvalidHttpCode: 9999 is above maximum HTTP status code 599

However, it can be set to nonstrict to not throw exceptions, and simply return the standard name/description not found for invalid objects, as such:

>>> from http_status import Status
>>> s = Status(9999, strict=False)
>>> s
<http_status.Status object at 0x1101905d0>
>>> s.name
'No HTTP Name'
>>> s.code
0

Note that if the Status object does not have a name/description matching the given code, it will return default strings (for compatability when directly inserting Status.name and Status.description into format strings.

This can be changed by passing arguments name_fail and description_fail when you create Status:

>>> from http_status import Status
>>> s = Status(243)
>>> s.name
'No HTTP Name'
>>> s.description
'No HTTP Description.'

>>> from http_status import Status
>>> s = Status(243, name_fail='Nothing', description_fail='Nothing at all')
>>> s.name
'Nothing'
>>> s.description
'Nothing at all'

The class NoneStatus is exactly the same as Status, but name_fail and description_fail both default to None.

Sources

Descriptions mostly adapted from:

License

Copyright (c) 2014 Daniel Oaks and contributors

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.

Six Library License

Copyright (c) 2010-2014 Benjamin Peterson

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.