Skip to content

Gio.FileAttributeMatcher

record (struct)

Determines if a string matches a file attribute.

Constructors

new

@classmethod
def new(cls, attributes: str) -> FileAttributeMatcher

Creates a new file attribute matcher, which matches attributes against a given string. [GFileAttributeMatchers]FileAttributeMatcher are reference counted structures, and are created with a reference count of 1. If the number of references falls to 0, the FileAttributeMatcher is automatically destroyed.

The attributes string should be formatted with specific keys separated from namespaces with a double colon. Several "namespace::key" strings may be concatenated with a single comma (e.g. "standard::type,standard::is-hidden"). The wildcard "*" may be used to match all keys and namespaces, or "namespace::*" will match all keys in a given namespace.

Examples of file attribute matcher strings and results

  • "*": matches all attributes.
  • "standard::is-hidden": matches only the key is-hidden in the standard namespace.
  • "standard::type,unix::*": matches the type key in the standard namespace and all keys in the unix namespace.

Parameters:

  • attributes — an attribute string to match.

Methods

enumerate_namespace

def enumerate_namespace(self, ns: str) -> bool

Checks if the matcher will match all of the keys in a given namespace. This will always return True if a wildcard character is in use (e.g. if matcher was created with "standard::*" and ns is "standard", or if matcher was created using "*" and namespace is anything.)

TODO: this is awkwardly worded.

Parameters:

  • ns — a string containing a file attribute namespace.

enumerate_next

def enumerate_next(self) -> str | None

Gets the next matched attribute from a FileAttributeMatcher.

matches

def matches(self, attribute: str) -> bool

Checks if an attribute will be matched by an attribute matcher. If the matcher was created with the "*" matching string, this function will always return True.

Parameters:

  • attribute — a file attribute key.

matches_only

def matches_only(self, attribute: str) -> bool

Checks if an attribute matcher only matches a given attribute. Always returns False if "*" was used when creating the matcher.

Parameters:

  • attribute — a file attribute key.

ref

def ref(self) -> FileAttributeMatcher

References a file attribute matcher.

subtract

def subtract(self, subtract: FileAttributeMatcher | None = ...) -> FileAttributeMatcher | None

Subtracts all attributes of subtract from matcher and returns a matcher that supports those attributes.

Note that currently it is not possible to remove a single attribute when the matcher matches the whole namespace - or remove a namespace or attribute when the matcher matches everything. This is a limitation of the current implementation, but may be fixed in the future.

Parameters:

  • subtract — The matcher to subtract

to_string

def to_string(self) -> str

Prints what the matcher is matching against. The format will be equal to the format passed to FileAttributeMatcher.new. The output however, might not be identical, as the matcher may decide to use a different order or omit needless parts.

unref

def unref(self) -> None

Unreferences matcher. If the reference count falls below 1, the matcher is automatically freed.