FePy Library Reference
======================

This document briefly explains additional constructs provided by
FePy library for the purpose of better .NET integration, which are absent
from the CPython standard library.

For constructs already present in the CPython standard library, consult
the `Python Library Reference`_ instead.

.. _Python Library Reference: http://docs.python.org/lib/lib.html

.. contents::

socket
------

See also socket__ module on the Python Library Reference.

__ http://docs.python.org/lib/module-socket.html

PythonSocket(Socket_ socket)
  Create a new Python socket object using the given .NET socket object.

PythonSocket objects have the following additional attributes:

socket
  Return the .NET socket object associated with the Python socket object.

hashlib
-------

See also md5__, sha__, hashlib__ module on the Python Library Reference.

__ http://docs.python.org/lib/module-md5.html
__ http://docs.python.org/lib/module-sha.html
__ http://docs.python.org/lib/module-hashlib.html

As .NET Framework doesn't provide SHA224 hash algorithm, ``sha224()``
constructor may raise ``NotImplementedError``.

``Mono.Security`` assembly implements SHA224 hash algorithm. ``hashlib`` tries
to load ``Mono.Security`` assembly, and use its implementation when it's
available.

PythonHash(HashAlgorithm_ context)
  Create a new Python hash object using the given .NET hash object.

PythonHash objects have the following additional attributes:

context
  Return the .NET hash object associated with the Python hash object.

.. _HashAlgorithm: http://msdn2.microsoft.com/en-us/library/system.security.cryptography.hashalgorithm.aspx
.. _Socket: http://msdn2.microsoft.com/en-us/library/system.net.sockets.socket.aspx