sdk/platform-tools/systrace/catapult/telemetry/third_party/pyfakefs/pyfakefs/README.md

   1 # pyfakefs
   2 pyfakefs implements a fake file system that mocks the Python file system modules.
   3 Using pyfakefs, your tests operate on a fake file system in memory without
   4 touching the real disk.  The software under test requires no modification to
   5 work with pyfakefs.
   6
   7 ## Usage
   8 See the [usage tutorial](http://github.com/jmcgeheeiv/pyfakefs/wiki/Tutorial)
   9 for a concrete example of how to apply pyfakefs.
  10
  11 ## Continuous Integration
  12 pyfakefs is tested with Python 2.6 and above.  See [Travis-CI](http://travis-ci.org) for
  13 [pyfakefs continuous integration test results](https://travis-ci.org/jmcgeheeiv/pyfakefs)
  14 for each Python version.
  15
  16 ## Installation
  17
  18 ### Compatibility
  19 pyfakefs works with Python 2.6 and above.  pyfakefs has no dependencies beyond the Python
  20 standard library.
  21
  22 ### PyPi
  23 pyfakefs project is hosted on PyPi and can be installed:
  24
  25 ```bash
  26 pip install pyfakefs
  27 ```
  28
  29 ## History
  30 pyfakefs.py was initially developed at Google by Mike Bland as a modest fake
  31 implementation of core Python modules.  It was introduced to all of Google
  32 in September 2006. Since then, it has been enhanced to extend its
  33 functionality and usefulness.  At Google alone, pyfakefs is used in over 2,000
  34 Python tests.
  35
  36 pyfakefs was released to the public in 2011 as Google Code project
  37 [pyfakefs](http://code.google.com/p/pyfakefs/).
  38
  39 Fork
  40 [jmcgeheeiv-pyfakefs](http://code.google.com/p/jmcgeheeiv-pyfakefs/)
  41 added a [usage tutorial](http://github.com/jmcgeheeiv/pyfakefs/wiki/Tutorial),
  42 direct support for [unittest](http://docs.python.org/2/library/unittest.html)
  43 and [doctest](http://docs.python.org/2/library/doctest.html).
  44
  45 Fork
  46 [shiffdane-jmcgeheeiv-pyfakefs](http://code.google.com/p/shiffdane-jmcgeheeiv-pyfakefs/)
  47 added further corrections.
  48
  49 After the [shutdown of Google Code was announced,](http://google-opensource.blogspot.com/2015/03/farewell-to-google-code.html)
  50 all three Google Code projects are merged together here on GitHub as pyfakefs.
  51