Skip to content

files Facts

The files facts provide information about the filesystem and it's contents on the target host.

Facts need to be imported before use, eg

from pyinfra.facts.files import File

See also: operations/files.

files.Block

host.get_fact(Block, path, marker=None, begin=None, end=None)

Returns a (possibly empty) list of the lines found between the markers.

[
    "xray: one",
    "alpha: two"
]

If the path doesn't exist returns None

If the path exists but the markers are not found returns []

files.Directory

host.get_fact(Directory, path)

Returns information about a directory on the remote system:

{
    "user": "pyinfra",
    "group": "pyinfra",
    "mode": 644,
}

If the path does not exist: returns None

If the path exists but is not a directory: returns False

files.File

host.get_fact(File, path)

Returns information about a file on the remote system:

{
    "user": "pyinfra",
    "group": "pyinfra",
    "mode": 644,
    "size": 3928,
}

If the path does not exist: returns None

If the path exists but is not a file: returns False

files.FileContents

host.get_fact(FileContents, path)

Returns the contents of a file as a list of lines, or None if the file does not exist.

files.FindDirectories

host.get_fact(FindDirectories, path, size=None, min_size=None, max_size=None, maxdepth=None, fname=None, iname=None, regex=None, path_match=None, args=None, quote_path=True)

Returns a list of directories from a start path, recursively using find.

files.FindFiles

host.get_fact(FindFiles, path, size=None, min_size=None, max_size=None, maxdepth=None, fname=None, iname=None, regex=None, path_match=None, args=None, quote_path=True)

Returns a list of files from a start path, recursively using find.

files.FindInFile

host.get_fact(FindInFile, path, pattern, interpolate_variables=False, extended_regex=False)

Checks for the existence of text in a file using grep. Returns a list of matching lines if the file exists, and None if the file does not.

host.get_fact(FindLinks, path, size=None, min_size=None, max_size=None, maxdepth=None, fname=None, iname=None, regex=None, path_match=None, args=None, quote_path=True)

Returns a list of links from a start path, recursively using find.

files.Flags

host.get_fact(Flags, path)

Returns a list of the file flags set for the specified file or directory.

host.get_fact(Link, path)

Returns information about a link on the remote system:

{
    "user": "pyinfra",
    "group": "pyinfra",
    "link_target": "/path/to/link/target"
}

If the path does not exist: returns None

If the path exists but is not a link: returns False

files.Md5File

host.get_fact(Md5File, path)

Returns an MD5 hash of a file, or None if the file does not exist.

files.Sha1File

host.get_fact(Sha1File, path)

Returns a SHA1 hash of a file. Works with both sha1sum and sha1. Returns None if the file doest not exist.

files.Sha256File

host.get_fact(Sha256File, path)

Returns a SHA256 hash of a file, or None if the file does not exist.

files.Sha384File

host.get_fact(Sha384File, path)

Returns a SHA384 hash of a file, or None if the file does not exist.

files.Socket

host.get_fact(Socket, path)

Returns information about a socket on the remote system:

{
    "user": "pyinfra",
    "group": "pyinfra",
}

If the path does not exist: returns None

If the path exists but is not a socket: returns False