Metadata-Version: 1.1
Name: libfaketime
Version: 0.4.2
Summary: A fast alternative to freezegun that wraps libfaketime.
Home-page: http://pypi.python.org/pypi/libfaketime/
Author: Simon Weber
Author-email: simon@simonmweber.com
License: GPLv2
Description: python-libfaketime: fast date/time mocking
        ==========================================
        
        .. image:: https://img.shields.io/travis/simon-weber/python-libfaketime.svg
                :target: https://travis-ci.org/simon-weber/python-libfaketime
        
        .. image:: https://img.shields.io/pypi/v/libfaketime.svg
                :target: https://pypi.python.org/pypi/libfaketime
        
        python-libfaketime is a wrapper of `libfaketime <https://github.com/wolfcw/libfaketime>`__ for python.
        
        Installation
        ------------
        
        Install with **pip**:
        
        .. code-block:: sh
        
            $ pip install libfaketime
        
        Usage
        -----
        
        .. code-block:: python
        
            import datetime
        
            from libfaketime import fake_time, reexec_if_needed
        
            # libfaketime needs to be preloaded by the dynamic linker.
            # This will exec the same command, but with the proper environment variables set.
            # You can also skip this and manually manage your env (see "How to avoid re-exec").
            reexec_if_needed()
        
            def get_tomorrow():
                return datetime.date.today() + datetime.timedelta(days=1)
        
        
            @fake_time('2014-01-01 00:00:00')
            def test_get_tomorrow():
                assert get_tomorrow() == datetime.date(2014, 1, 2)
        
        
        It serves as a fast drop-in replacement for `freezegun <https://github.com/spulec/freezegun>`__.
        Here's the output of a `totally unscientific benchmark <https://github.com/simon-weber/python-libfaketime/blob/master/benchmark.py>`__ on my laptop:
        
        .. code-block:: sh
        
            $ python benchmark.py
            re-exec with libfaketime dependencies
            timing 1000 executions of <class 'libfaketime.fake_time'>
            0.021755 seconds
        
            $ python benchmark.py freezegun
            timing 1000 executions of <function freeze_time at 0x10aaa1140>
            6.561472 seconds
        
        
        Some brief details:
        
        * Linux and OS X, Pythons 2 and 3
        * Microsecond resolution
        * Accepts datetimes and strings that can be parsed by dateutil
        * Not threadsafe
        * Will break profiling. A workaround: use ``libfaketime.{begin, end}_callback`` to disable/enable your profiler.
        
        
        Use with py.test
        ----------------
        
        It's easiest to reexec from inside the pytest_configure hook:
        
        .. code-block:: python
        
            # conftest.py
            from libfaketime import reexec_if_needed
        
            def pytest_configure():
                reexec_if_needed()
        
        
        How to avoid re-exec
        --------------------
        
        Sometimes, re-exec does unexpected things. You can avoid those problems by preloading libfaketime yourself. The environment variables you need
        can be found by running `python-libfaketime` on the command line:
        
        .. code-block:: sh
        
            $ python-libfaketime
            export LD_PRELOAD="/home/foo/<snip>/vendor/libfaketime/src/libfaketime.so.1"
            export FAKETIME_DID_REEXEC=true
        
        You can use them as such:
        
        .. code-block:: sh
        
            $ eval $(python-libfaketime)
            $ nosetests  # ...or any other code that imports libfaketime
        
        Known Issues
        ------------
        
        It was found that calling `uuid.uuid1()` multiple times while in a fake_time context could result in a deadlock. This situation only occured for users with
        a system level uuid1 library. In order to combat this issue, python-libfaketime temporarily disables the system level library by patching
        `_uuid_generate_time to None <https://github.com/python/cpython/blob/a1786b287598baa4a9146c9938c9a667bd98fc00/Lib/uuid.py#L565-L570>`_ while in
        the fake_time context.
        
        
        .. :changelog:
        
        Changelog
        ---------
        
        `Semantic versioning <http://semver.org/>`__ is used.
        
        0.4.2
        +++++
        released 2016-06-30
        
        - fix only_main_thread=False: [#24](https://github.com/simon-weber/python-libfaketime/pull/24)
        
        0.4.1
        +++++
        released 2016-05-02
        
        - fix deadlocks from uuid.uuid1 when faking time: [#14](https://github.com/simon-weber/python-libfaketime/pull/14)
        - remove contextdecorator dependency on python3: [#15](https://github.com/simon-weber/python-libfaketime/pull/15)
        
        0.4.0
        +++++
        released 2016-04-02
        
        - freezegun's tick() is now supported; see `their docs <https://github.com/spulec/freezegun/blob/f1f5148720dd715cfd6dc03bf1861dbedfaad493/README.rst#manual-ticks>`__ for usage.
        
        0.3.0
        +++++
        released 2016-03-04
        
        - invoking ``libfaketime`` from the command line will now print the necessary environment to avoid a re-exec.
        
        0.2.1
        +++++
        released 2016-03-01
        
        - python 3 support
        
        0.1.1
        +++++
        released 2015-09-11
        
        - prevent distribution of test directory: https://github.com/simon-weber/python-libfaketime/pull/4
        
        0.1.0
        +++++
        released 2015-06-23
        
        - add global start/stop callbacks
        
        0.0.3
        +++++
        released 2015-03-28
        
        - initial packaged release
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
