• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Public Modules and Classes
2==========================
3.. note:: Only public classes and methods interesting to ``pyfakefs``
4  users are shown. Methods that mimic the behavior of standard Python
5  functions and classes that are only needed internally are not listed.
6
7Fake filesystem module
8----------------------
9.. automodule:: pyfakefs.fake_filesystem
10    :members: set_uid, set_gid
11
12Fake filesystem classes
13-----------------------
14.. autoclass:: pyfakefs.fake_filesystem.FakeFilesystem
15    :members: add_mount_point,
16        get_disk_usage, set_disk_usage,
17        add_real_directory, add_real_file, add_real_symlink, add_real_paths,
18        create_dir, create_file, create_symlink,
19        get_object, pause, resume
20
21.. autoclass:: pyfakefs.fake_filesystem.FakeFile
22    :members: byte_contents, contents, set_contents,
23        path, size, is_large_file
24
25.. autoclass:: pyfakefs.fake_filesystem.FakeDirectory
26    :members: contents, ordered_dirs, size, get_entry, remove_entry
27
28Unittest module classes
29-----------------------
30
31.. autoclass:: pyfakefs.fake_filesystem_unittest.TestCaseMixin
32    :members: fs, setUpPyfakefs, pause, resume
33
34.. autoclass:: pyfakefs.fake_filesystem_unittest.TestCase
35
36.. autoclass:: pyfakefs.fake_filesystem_unittest.Patcher
37    :members: setUp, tearDown, pause, resume
38
39.. automodule:: pyfakefs.fake_filesystem_unittest
40    :members: patchfs
41
42
43Faked module classes
44--------------------
45
46.. autoclass:: pyfakefs.fake_filesystem.FakeOsModule
47
48.. autoclass:: pyfakefs.fake_filesystem.FakePathModule
49
50.. autoclass:: pyfakefs.fake_filesystem.FakeFileOpen
51
52.. autoclass:: pyfakefs.fake_filesystem.FakeIoModule
53
54.. autoclass:: pyfakefs.fake_filesystem_shutil.FakeShutilModule
55
56.. autoclass:: pyfakefs.fake_pathlib.FakePathlibModule
57
58.. autoclass:: pyfakefs.fake_scandir.FakeScanDirModule
59