mypy.fscache.FileSystemCache

class documentation

class FileSystemCache: (source)

Known subclasses: mypy.test.test_find_sources.FakeFSCache

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method exists Undocumented
Method exists​_case Return whether path exists - checking path components in case sensitive fashion, up to prefix.
Method flush Start another transaction and empty all caches.
Method hash​_digest Undocumented
Method init​_under​_package​_root Is this path an __init__.py under a package root?
Method isdir Undocumented
Method isfile Undocumented
Method isfile​_case Return whether path exists and is a file.
Method listdir Undocumented
Method read Undocumented
Method samefile Undocumented
Method set​_package​_root Undocumented
Method stat Undocumented
Instance Variable exists​_case​_cache Undocumented
Instance Variable fake​_package​_cache Undocumented
Instance Variable hash​_cache Undocumented
Instance Variable isfile​_case​_cache Undocumented
Instance Variable listdir​_cache Undocumented
Instance Variable listdir​_error​_cache Undocumented
Instance Variable package​_root Undocumented
Instance Variable read​_cache Undocumented
Instance Variable read​_error​_cache Undocumented
Instance Variable stat​_cache Undocumented
Instance Variable stat​_error​_cache Undocumented
Method _fake​_init Prime the cache with a fake __init__.py file.
def __init__(self): (source)
overridden in mypy.test.test_find_sources.FakeFSCache

Undocumented

def exists(self, path): (source)

Undocumented

Parameters
path:strUndocumented
Returns
boolUndocumented
def exists_case(self, path, prefix): (source)
Return whether path exists - checking path components in case sensitive fashion, up to prefix.
Parameters
path:strUndocumented
prefix:strUndocumented
Returns
boolUndocumented
def flush(self): (source)
Start another transaction and empty all caches.
def hash_digest(self, path): (source)

Undocumented

Parameters
path:strUndocumented
Returns
strUndocumented
def init_under_package_root(self, path): (source)
overridden in mypy.test.test_find_sources.FakeFSCache

Is this path an __init__.py under a package root?

This is used to detect packages that don't contain __init__.py files, which is needed to support Bazel. The function should only be called for non-existing files.

It will return True if it refers to a __init__.py file that Bazel would create, so that at runtime Python would think the directory containing it is a package. For this to work you must pass one or more package roots using the --package-root flag.

As an exceptional case, any directory that is a package root itself will not be considered to contain a __init__.py file. This is different from the rules Bazel itself applies, but is necessary for mypy to properly distinguish packages from other directories.

See https://docs.bazel.build/versions/master/be/python.html, where this behavior is described under legacy_create_init.

Parameters
path:strUndocumented
Returns
boolUndocumented
def isdir(self, path): (source)
overridden in mypy.test.test_find_sources.FakeFSCache

Undocumented

Parameters
path:strUndocumented
Returns
boolUndocumented
def isfile(self, path): (source)
overridden in mypy.test.test_find_sources.FakeFSCache

Undocumented

Parameters
path:strUndocumented
Returns
boolUndocumented
def isfile_case(self, path, prefix): (source)

Return whether path exists and is a file.

On case-insensitive filesystems (like Mac or Windows) this returns False if the case of path's last component does not exactly match the case found in the filesystem.

We check also the case of other path components up to prefix. For example, if path is 'user-stubs/pack/mod.pyi' and prefix is 'user-stubs', we check that the case of 'pack' and 'mod.py' matches exactly, 'user-stubs' will be case insensitive on case insensitive filesystems.

The caller must ensure that prefix is a valid file system prefix of path.

Parameters
path:strUndocumented
prefix:strUndocumented
Returns
boolUndocumented
def listdir(self, path): (source)
overridden in mypy.test.test_find_sources.FakeFSCache

Undocumented

Parameters
path:strUndocumented
Returns
List[str]Undocumented
def read(self, path): (source)

Undocumented

Parameters
path:strUndocumented
Returns
bytesUndocumented
def samefile(self, f1, f2): (source)

Undocumented

Parameters
f1:strUndocumented
f2:strUndocumented
Returns
boolUndocumented
def set_package_root(self, package_root): (source)

Undocumented

Parameters
package​_root:List[str]Undocumented
def stat(self, path): (source)

Undocumented

Parameters
path:strUndocumented
Returns
os.stat_resultUndocumented
exists_case_cache: Dict[str, bool] = (source)

Undocumented

fake_package_cache: Set[str] = (source)

Undocumented

hash_cache: Dict[str, str] = (source)

Undocumented

isfile_case_cache: Dict[str, bool] = (source)

Undocumented

listdir_cache: Dict[str, List[str]] = (source)

Undocumented

listdir_error_cache: Dict[str, OSError] = (source)

Undocumented

package_root = (source)

Undocumented

read_cache: Dict[str, bytes] = (source)

Undocumented

read_error_cache: Dict[str, Exception] = (source)

Undocumented

stat_cache: Dict[str, os.stat_result] = (source)

Undocumented

stat_error_cache: Dict[str, OSError] = (source)

Undocumented

def _fake_init(self, path): (source)

Prime the cache with a fake __init__.py file.

This makes code that looks for path believe an empty file by that name exists. Should only be called after init_under_package_root() returns True.

Parameters
path:strUndocumented
Returns
os.stat_resultUndocumented