Finder Module Reference
New in version 0.0.1.
Control Finder using JXA-like syntax.
Classes:
|
A class for managing and interacting with alias files in Finder.app. |
|
A wrapper around lists of alias files that employs fast enumeration techniques. |
|
A class for managing and interacting with Finder.app. |
|
A class for managing and interacting with application files in Finder.app. |
|
A wrapper around lists of application files that employs fast enumeration techniques. |
|
A class for managing and interacting with clippings in Finder.app. |
|
A wrapper around lists of clippings that employs fast enumeration techniques. |
|
A class for managing and interacting with clipping windows in Finder. |
|
A wrapper around lists of clipping windows that employs fast enumeration techniques. |
|
A class for managing and interacting with columns in Finder windows. |
|
A wrapper around lists of Finder columns that employs fast enumeration techniques. |
|
A class representing the column view options of a Finder window. |
|
A class for managing and interacting with the Desktop. |
|
A class for managing and interacting with containers in Finder. |
|
A wrapper around lists of containers that employs fast enumeration techniques. |
|
A class for managing and interacting with the Desktop. |
|
A class representing the containing window around Finder's desktop element. |
|
A class for managing and interacting with disks in Finder. |
|
A wrapper around lists of disks that employs fast enumeration techniques. |
|
A class for managing and interacting with document files in Finder.app. |
|
A wrapper around lists of document files that employs fast enumeration techniques. |
|
A class for managing and interacting with files in Finder. |
|
A wrapper around lists of files that employs fast enumeration techniques. |
|
A class for managing and interacting with internal windows within Finder.app. |
|
A wrapper around lists of Finder internal windows (such as preference and information windows) that employs fast enumeration techniques. |
|
A class for managing and interacting with folders in Finder. |
|
A wrapper around lists of folders that employs fast enumeration techniques. |
|
A class representing the icon view options of a Finder window. |
|
A class for interacting with information windows in Finder.app. |
|
A wrapper around lists of info windows that employs fast enumeration techniques. |
|
A class for managing and interacting with internet location files in Finder.app. |
|
A wrapper around lists of internet location files that employs fast enumeration techniques. |
|
A generic class with methods common to the various item classes of Finder. |
|
A wrapper around lists of Finder items that employs fast enumeration techniques. |
|
A class representing the list view options in a Finder window. |
|
A class for managing and interacting with packages in Finder.app. |
|
A wrapper around lists of packages that employs fast enumeration techniques. |
|
A class for managing general preferences of Finder.app. |
|
A class for managing and interacting with preference windows in Finder.app. |
|
A class for managing and interacting with Finder's Trash. |
|
A class for managing and interacting with windows of Finder.app. |
|
A wrapper around lists of Finder windows that employs fast enumeration techniques. |
- class PyXA.apps.Finder.XAFinderAliasFile(properties)[source]
Bases:
XAFinderFile
A class for managing and interacting with alias files in Finder.app.
New in version 0.0.3.
Attributes:
The original item pointed to by the alias.
- property original_item: XAFinderItem
The original item pointed to by the alias.
- class PyXA.apps.Finder.XAFinderAliasFileList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderFileList
A wrapper around lists of alias files that employs fast enumeration techniques.
All properties of alias files can be called as methods on the wrapped list, returning a list containing each alias files’s value for the property.
New in version 0.0.3.
Methods:
by_original_item
(original_item)- by_original_item(original_item: XAFinderItem) XAFinderAliasFile | None [source]
- original_item() list[XAFinderItem] [source]
- class PyXA.apps.Finder.XAFinderApplication(properties)[source]
Bases:
XASBApplication
,XACanOpenPath
A class for managing and interacting with Finder.app.
Changed in version 0.0.3: Added methods and properties to reach parity with Finder.h.
New in version 0.0.1.
Classes:
Arrangement
(value)Arrangement options for lists of items in Finder windows.
ColumnName
(value)Columns in Finder windows.
IconSize
(value)Options for the size of icons in Finder windows.
ItemFormat
(value)Options for file and disk formats of Finder items.
LabelPosition
(value)Options for the label position of items in Finder windows.
Panel
(value)Options for information panels in Finder.
PrivacySetting
(value)Options for privacy settings on Finder items.
SortDirection
(value)Options for sort direction of lists of Finder items.
ViewSetting
(value)View options for lists of items in Finder windows.
Methods:
alias_files
([filter])Returns a list of alias files matching the filter.
application_files
([filter])Returns a list of application files matching the filter.
Obtains a reference to the system applications directory.
clipping_windows
([filter])Returns a list of clipping windows matching the filter.
clippings
([filter])Returns a list of clippings matching the filter.
containers
([filter])Returns a list of containers matching the filter.
delete_item
(path)Permanently deletes the file or folder at the specified path.
directory
(path)Deprecated since version 0.1.1.
disks
([filter])Returns a list of disks matching the filter.
document_files
([filter])Returns a list of document files matching the filter.
Obtains a reference to the current user's documents directory.
Obtains a reference to the current user's downloads directory.
duplicate_item
(path)Duplicates the specified file or folder in its containing folder.
Empties the trash.
files
([filter])Returns a list of files matching the filter.
finder_windows
([filter])Returns a list of Finder windows matching the filter.
folders
([filter])Returns a list of folders matching the filter.
Gets the list of file labels.
Obtains a reference to the current user's home directory.
internet_location_files
([filter])Returns a list of internet location files matching the filter.
items
([filter])Returns a list of items matching the filter.
Obtains a reference to the current user's movies directory.
Obtains a reference to the current user's music directory.
packages
([filter])Returns a list of packages matching the filter.
Obtains a reference to the current user's pictures directory.
Obtains a reference to the public directory.
recycle_item
(path)Moves the file or folder at the specified path to the trash.
search
(query)Opens a Finder search window and searches for the specified term.
select_item
(path)Selects the file or folder at the specified path.
select_items
(paths)Selects the files or folders at the specified paths.
Obtains a reference to the temporary directory for the current user.
Obtains a reference to the current user's trash directory.
Attributes:
The computer directory.
The user's desktop.
The desktop picture of the main monitor.
Preferences for Finder as a whole.
Whether Finder is the active application.
The home directory.
The container in which a new folder would be created in by default in the frontmost window.
The name of the application.
The system software version.
The currently selected items in Finder.
The startup disk for this system.
The system Trash.
The version of Finder
Whether Finder is currently visible.
- class Arrangement(value)[source]
Bases:
Enum
Arrangement options for lists of items in Finder windows.
Attributes:
- BY_CREATION_DATE = 1667527777
- BY_KIND = 1802071649
- BY_LABEL = 1818321505
- BY_MODIFICATION_DATE = 1835299937
- BY_NAME = 1851878753
- BY_SIZE = 1936292449
- NOT_ARRANGED = 1851880050
- SNAP_TO_GRID = 1735550049
- class ColumnName(value)[source]
Bases:
Enum
Columns in Finder windows.
Attributes:
- COMMENT = 1701606211
- CREATION_DATE = 1701606243
- KIND = 1701606251
- LABEL = 1701606252
- MODIFICATE_DATE = 1701606253
- NAME = 1702063214
- SIZE = 1701606259
- VERSION = 1701606262
- class IconSize(value)[source]
Bases:
Enum
Options for the size of icons in Finder windows.
Attributes:
- LARGE = 1818716515
- SMALL = 1936550243
- class ItemFormat(value)[source]
Bases:
Enum
Options for file and disk formats of Finder items.
Attributes:
- APFS = 1684431216
- APPLE_PHOTO = 1684435048
- APPLE_SHARE = 1684431219
- AUDIO = 1684431221
- EXFAT = 1684437094
- FTP = 1684432500
- HIGH_SIERRA = 1684433011
- ISO9660 = 1684420918
- MACOS = 1684432998
- MACOS_EXTENDED = 1684432939
- MSDOS = 1684434291
- NFS = 1684434534
- NTFS = 1684434548
- PACKET_WRITTEN_UDF = 1684435061
- PRO_DOS = 1684435058
- QUICKTAKE = 1684435316
- SMB = 1684435821
- UDF = 1684436324
- UFS = 1684436326
- UNKNOWN = 110390797098047
- WEBDAV = 1684436836
- XSAN = 1684431203
- class LabelPosition(value)[source]
Bases:
Enum
Options for the label position of items in Finder windows.
Attributes:
- BOTTOM = 1818390388
- RIGHT = 1819436916
- class Panel(value)[source]
Bases:
Enum
Options for information panels in Finder.
Attributes:
- ADVANCED_PREFERENCES = 1885430902
- APPLICATION = 1634758252
- BURNING = 1651535468
- COMMENTS = 1668312684
- CONTENT_INDEX = 1667853932
- GENERAL_INFORMATION = 1735421548
- GENERAL_PREFERENCES = 1885826672
- LABEL_PREFERENCES = 1886151280
- LANGUAGES = 1886088295
- MEMORY = 1836084844
- MORE_INFO = 1835626092
- NAME_EXTENSION = 1852862060
- PLUGINS = 1886089319
- PREVIEW = 1987079788
- SHARING = 1936748140
- SIDEBAR_PREFERENCES = 1886611812
- SIMPLE_HEADER = 1936223852
- class PrivacySetting(value)[source]
Bases:
Enum
Options for privacy settings on Finder items.
Attributes:
- NONE = 1852796517
- READ_ONLY = 1919246692
- READ_WRITE = 1919186802
- WRITE_ONLY = 2003986804
- class SortDirection(value)[source]
Bases:
Enum
Options for sort direction of lists of Finder items.
Attributes:
- NORMAL = 1936618093
- REVERSED = 1936881267
- class ViewSetting(value)[source]
Bases:
Enum
View options for lists of items in Finder windows.
Attributes:
- COLUMN_VIEW = 1668052599
- FLOW_VIEW = 1718384247
- GROUP_VIEW = 1718384247
- ICON_VIEW = 1768124022
- LIST_VIEW = 1819506295
- alias_files(filter: dict | None = None) XAFinderAliasFileList [source]
Returns a list of alias files matching the filter.
New in version 0.0.3.
- application_files(filter: dict | None = None) XAFinderApplicationFileList [source]
Returns a list of application files matching the filter.
New in version 0.0.3.
- applications_directory() XAFinderFolder [source]
Obtains a reference to the system applications directory.
- Returns:
A PyXA reference to the system applications directory.
- Return type:
New in version 0.0.1.
- clipping_windows(filter: dict | None = None) XAFinderClippingWindowList [source]
Returns a list of clipping windows matching the filter.
New in version 0.0.3.
- clippings(filter: dict | None = None) XAFinderClippingList [source]
Returns a list of clippings matching the filter.
New in version 0.0.3.
- property computer_container: XAFinderComputer
The computer directory.
- containers(filter: dict | None = None) XAFinderContainerList [source]
Returns a list of containers matching the filter.
New in version 0.0.3.
- delete_item(path: str | NSURL) XAFinderApplication [source]
Permanently deletes the file or folder at the specified path.
- param path:
The path of the file or folder to delete.
- type path:
Union[str, AppKit.NSURL]
- return:
A reference to the Finder application object.
- rtype:
XAFinderApplication
- Example:
>>> import PyXA >>> app = PyXA.Application("Finder") >>> app.delete_item("/Users/exampleuser/Documents/Example.txt")
See also
delete_items()
New in version 0.0.1.
- property desktop: XAFinderDesktop
The user’s desktop.
- property desktop_picture: XAFinderFile
The desktop picture of the main monitor.
- directory(path: str | NSURL)[source]
Deprecated since version 0.1.1.
Use the
folders()
method with a filter instead.
- disks(filter: dict | None = None) XAFinderDiskList [source]
Returns a list of disks matching the filter.
New in version 0.0.3.
- document_files(filter: dict | None = None) XAFinderDocumentFileList [source]
Returns a list of document files matching the filter.
New in version 0.0.3.
- documents_directory() XAFinderFolder [source]
Obtains a reference to the current user’s documents directory.
- Returns:
A PyXA reference to the user’s documents directory.
- Return type:
New in version 0.0.1.
- downloads_directory() XAFinderFolder [source]
Obtains a reference to the current user’s downloads directory.
- Returns:
A PyXA reference to the user’s downloads directory.
- Return type:
New in version 0.0.1.
- duplicate_item(path: str) XAFinderApplication [source]
Duplicates the specified file or folder in its containing folder.
The duplicated item will have the name of the original with “ 2” added to the end.
- param path:
The path of the file or folder to duplicate.
- type path:
str
- return:
A reference to the Finder application object.
- rtype:
XAFinderApplication
- Example:
>>> import PyXA >>> app = PyXA.Application("Finder") >>> app.duplicate_item("/Users/exampleuser/Documents/Example.txt")
See also
duplicate_items()
New in version 0.0.1.
- empty_trash() XAFinderApplication [source]
Empties the trash.
- return:
A reference to the Finder application object.
- rtype:
XAFinderApplication
- Example:
>>> import PyXA >>> app = PyXA.Application("Finder") >>> app.empty_trash()
New in version 0.0.1.
- files(filter: dict | None = None) XAFinderFileList [source]
Returns a list of files matching the filter.
New in version 0.0.1.
- property finder_preferences: XAFinderPreferences
Preferences for Finder as a whole.
- finder_windows(filter: dict | None = None) XAFinderFinderWindowList [source]
Returns a list of Finder windows matching the filter.
New in version 0.0.3.
- folders(filter: dict | None = None) XAFinderFolderList [source]
Returns a list of folders matching the filter.
New in version 0.0.1.
- property frontmost: bool
Whether Finder is the active application.
- get_labels() list[str] [source]
Gets the list of file labels.
- Returns:
The list of file labels.
- Return type:
str
New in version 0.0.1.
- property home: XAFinderFolder
The home directory.
- home_directory() XAFinderFolder [source]
Obtains a reference to the current user’s home directory.
- Returns:
A PyXA reference to the user’s home directory.
- Return type:
New in version 0.0.1.
- property insertion_location: XAFinderFolder
The container in which a new folder would be created in by default in the frontmost window.
- internet_location_files(filter: dict | None = None) XAFinderInternetLocationFileList [source]
Returns a list of internet location files matching the filter.
New in version 0.0.3.
- items(filter: dict | None = None) XAFinderItemList [source]
Returns a list of items matching the filter.
New in version 0.0.1.
- movies_directory() XAFinderFolder [source]
Obtains a reference to the current user’s movies directory.
- Returns:
A PyXA reference to the user’s movies directory.
- Return type:
New in version 0.0.1.
- music_directory() XAFinderFolder [source]
Obtains a reference to the current user’s music directory.
- Returns:
A PyXA reference to the user’s music directory.
- Return type:
New in version 0.0.1.
- property name: str
The name of the application.
- packages(filter: dict | None = None) XAFinderPackageList [source]
Returns a list of packages matching the filter.
New in version 0.0.3.
- pictures_directory() XAFinderFolder [source]
Obtains a reference to the current user’s pictures directory.
- Returns:
A PyXA reference to the user’s pictures directory.
- Return type:
New in version 0.0.1.
- property product_version: str
The system software version.
- public_directory() XAFinderFolder [source]
Obtains a reference to the public directory.
- Returns:
A PyXA reference to the public directory.
- Return type:
New in version 0.0.1.
- recycle_item(path: str | NSURL) XAFinderApplication [source]
Moves the file or folder at the specified path to the trash.
- param path:
The path of the file or folder to recycle.
- type path:
Union[str, AppKit.NSURL]
- return:
A reference to the Finder application object.
- rtype:
XAFinderApplication
- Example:
>>> import PyXA >>> app = PyXA.Application("Finder") >>> app.recycle_item("/Users/exampleuser/Documents/Example.txt")
See also
recycle_items()
New in version 0.0.1.
- search(query: str) XAFinderApplication [source]
Opens a Finder search window and searches for the specified term.
- Parameters:
query (str) – The term to search.
- Returns:
A reference to the Finder application object.
- Return type:
New in version 0.0.1.
- select_item(path: str) XAFinderApplication [source]
Selects the file or folder at the specified path.
This opens a new tab of Finder unless the current tab is the parent folder of the provided path and no item is currently selected.
- Parameters:
path (str) – The path of the file or folder to select.
- Returns:
A reference to the Finder application object.
- Return type:
- Example:
>>> import PyXA >>> app = PyXA.Application("Finder") >>> app.select_item("/Users/exampleuser/Documents/Example.txt")
See also
New in version 0.0.1.
- select_items(paths: list[str]) XAFinderApplication [source]
Selects the files or folders at the specified paths.
This opens a new tab of Finder for each different parent folder in the list of paths to select. This method utilizes fast specialized methods from Objective-C to improve the performance of selecting large amounts of files. As such, when dealing with multiple file paths, this method should always be used instead of calling
select_item()
repeatedly.- Parameters:
path – The paths to select.
- Returns:
A reference to the Finder application object.
- Return type:
- Example:
>>> import PyXA >>> app = PyXA.Application("Finder") >>> items = ["/Users/exampleuser/Documents/Example 1.txt", "/Users/exampleuser/Documents/Example 2.txt"] >>> app.select_items(items)
See also
New in version 0.0.1.
- property selection: XAFinderItemList
The currently selected items in Finder.
- property startup_disk: XAFinderDisk
The startup disk for this system.
- temp_directory() XAFinderFolder [source]
Obtains a reference to the temporary directory for the current user.
- Returns:
A PyXA reference to the user’s temporary directory.
- Return type:
New in version 0.0.1.
- property trash: XAFinderTrash
The system Trash.
- trash_directory() XAFinderFolder [source]
Obtains a reference to the current user’s trash directory.
- Returns:
A PyXA reference to the user’s trash directory.
- Return type:
New in version 0.0.1.
- property version: str
The version of Finder
- property visible: bool
Whether Finder is currently visible.
- class PyXA.apps.Finder.XAFinderApplicationFile(properties)[source]
Bases:
XAFinderFile
A class for managing and interacting with application files in Finder.app.
New in version 0.0.3.
Attributes:
Whether the process can be scripted.
The bundle identifier or creator type of the application.
- property has_scripting_terminology: bool
Whether the process can be scripted.
- property id: str
The bundle identifier or creator type of the application.
- class PyXA.apps.Finder.XAFinderApplicationFileList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderFileList
A wrapper around lists of application files that employs fast enumeration techniques.
All properties of application files can be called as methods on the wrapped list, returning a list containing each application file’s value for the property.
New in version 0.0.3.
Methods:
by_id
(id)id
()- by_has_scripting_terminology(has_scripting_terminology: bool) XAFinderApplicationFile | None [source]
- by_id(id: str) XAFinderApplicationFile | None [source]
- class PyXA.apps.Finder.XAFinderClipping(properties)[source]
Bases:
XAFinderFile
A class for managing and interacting with clippings in Finder.app.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderClippingList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderFileList
A wrapper around lists of clippings that employs fast enumeration techniques.
All properties of clippings can be called as methods on the wrapped list, returning a list containing each clipping’s value for the property.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderClippingWindow(properties)[source]
Bases:
XAFinderWindow
,XASBPrintable
A class for managing and interacting with clipping windows in Finder.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderClippingWindowList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderWindowList
A wrapper around lists of clipping windows that employs fast enumeration techniques.
All properties of clipping windows can be called as methods on the wrapped list, returning a list containing each window’s value for the property.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderColumn(properties)[source]
Bases:
XAObject
A class for managing and interacting with columns in Finder windows.
New in version 0.0.3.
Attributes:
The index of the column in the front-to-back ordering within the containing window.
The maximum width allowed for the column in pixels.
The minimum width allowed for the column in pixels.
The column name.
The direction which the window is sorted.
Whether the column is visible.
The current width of the column in pixels.
- property index: int
The index of the column in the front-to-back ordering within the containing window.
- property maximum_width: int
The maximum width allowed for the column in pixels.
- property minimum_width: int
The minimum width allowed for the column in pixels.
- property name: ColumnName
The column name.
- property sort_direction: SortDirection
The direction which the window is sorted.
- property visible: bool
Whether the column is visible.
- property width: int
The current width of the column in pixels.
- class PyXA.apps.Finder.XAFinderColumnList(properties: dict, filter: dict | None = None)[source]
Bases:
XAList
A wrapper around lists of Finder columns that employs fast enumeration techniques.
All properties of Finder columns can be called as methods on the wrapped list, returning a list containing each columns’s value for the property.
New in version 0.0.3.
Methods:
by_index
(index)by_maximum_width
(maximum_width)by_minimum_width
(minimum_width)by_name
(name)by_sort_direction
(sort_direction)by_visible
(visible)by_width
(width)index
()Returns the index of the first occurrence of the element in the list, or -1 if no such element exists in the list.
name
()visible
()width
()- by_index(index: int) XAFinderColumn | None [source]
- by_maximum_width(maximum_width: int) XAFinderColumn | None [source]
- by_minimum_width(minimum_width: int) XAFinderColumn | None [source]
- by_name(name: str) XAFinderColumn | None [source]
- by_sort_direction(sort_direction: SortDirection) XAFinderColumn | None [source]
- by_visible(visible: bool) XAFinderColumn | None [source]
- by_width(width: int) XAFinderColumn | None [source]
- index() list[int] [source]
Returns the index of the first occurrence of the element in the list, or -1 if no such element exists in the list.
New in version 0.1.2.
- sort_direction() list[SortDirection] [source]
- class PyXA.apps.Finder.XAFinderColumnViewOptions(properties)[source]
Bases:
XAObject
A class representing the column view options of a Finder window.
New in version 0.0.3.
Attributes:
Whether the preview pane is disclosed in the column view.
Whether icons are shown in the column view.
Whether icon previews are shown in the column view.
Whether the preview column is shown in the column view.
The size of text in the column view.
- property discloses_preview_pane: bool
Whether the preview pane is disclosed in the column view.
- property shows_icon: bool
Whether icons are shown in the column view.
- property shows_icon_preview: bool
Whether icon previews are shown in the column view.
- property shows_preview_column: bool
Whether the preview column is shown in the column view.
- property text_size: int
The size of text in the column view.
- class PyXA.apps.Finder.XAFinderComputer(properties)[source]
Bases:
XAFinderItem
A class for managing and interacting with the Desktop.
New in version 0.0.2.
- class PyXA.apps.Finder.XAFinderContainer(properties)[source]
Bases:
XAFinderItem
A class for managing and interacting with containers in Finder.
See also
New in version 0.0.2.
Methods:
alias_files
([filter])Returns a list of alias files matching the filter.
application_files
([filter])Returns a list of application files matching the filter.
clippings
([filter])Returns a list of clippings matching the filter.
containers
([filter])Returns a list of containers matching the filter.
document_files
([filter])Returns a list of document files matching the filter.
files
([filter])Returns a list of files matching the filter.
folders
([filter])Returns a list of folders matching the filter.
internet_location_files
([filter])Returns a list of internet location files matching the filter.
items
([filter])Returns a list of items matching the filter.
packages
([filter])Returns a list of packages matching the filter.
Attributes:
The container window for this folder.
The entire contents of the container, including the contents of its children.
- alias_files(filter: dict | None = None) XAFinderAliasFileList [source]
Returns a list of alias files matching the filter.
New in version 0.0.3.
- application_files(filter: dict | None = None) XAFinderApplicationFileList [source]
Returns a list of application files matching the filter.
New in version 0.0.3.
- clippings(filter: dict | None = None) XAFinderClippingList [source]
Returns a list of clippings matching the filter.
New in version 0.0.3.
- property container_window
The container window for this folder.
- containers(filter: dict | None = None) XAFinderContainerList [source]
Returns a list of containers matching the filter.
New in version 0.0.3.
- document_files(filter: dict | None = None) XAFinderDocumentFileList [source]
Returns a list of document files matching the filter.
New in version 0.0.3.
- property entire_contents
The entire contents of the container, including the contents of its children.
- files(filter: dict | None = None) XAFinderFileList [source]
Returns a list of files matching the filter.
New in version 0.0.1.
- folders(filter: dict | None = None) XAFinderFolderList [source]
Returns a list of folders matching the filter.
New in version 0.0.1.
- internet_location_files(filter: dict | None = None) XAFinderInternetLocationFileList [source]
Returns a list of internet location files matching the filter.
New in version 0.0.3.
- items(filter: dict | None = None) XAFinderItemList [source]
Returns a list of items matching the filter.
New in version 0.0.3.
- packages(filter: dict | None = None) XAFinderPackageList [source]
Returns a list of packages matching the filter.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderContainerList(properties: dict, filter: dict | None = None, object_class=None)[source]
Bases:
XAFinderItemList
A wrapper around lists of containers that employs fast enumeration techniques.
All properties of containers can be called as methods on the wrapped list, returning a list with each container’s value for the property.
New in version 0.0.3.
Methods:
by_container_window
(container_window)by_entire_contents
(entire_contents)files
()folders
()items
()packages
()- alias_files() XAFinderAliasFileList [source]
- application_files() XAFinderApplicationFileList [source]
- by_container_window(container_window: XAFinderFinderWindow) XAFinderContainer | None [source]
- by_entire_contents(entire_contents: XAFinderItemList) XAFinderContainer | None [source]
- clippings() XAFinderClippingList [source]
- container_window() XAFinderFinderWindowList [source]
- containers() XAFinderContainerList [source]
- document_files() XAFinderDocumentFileList [source]
- entire_contents() XAFinderItemList [source]
- files() XAFinderFileList [source]
- folders() XAFinderFolderList [source]
- internet_location_files() XAFinderInternetLocationFileList [source]
- items() XAFinderItemList [source]
- packages() XAFinderPackageList [source]
- class PyXA.apps.Finder.XAFinderDesktop(properties)[source]
Bases:
XAFinderContainer
A class for managing and interacting with the Desktop.
New in version 0.0.2.
Attributes:
The desktop window.
- property window: XAFinderDesktopWindow
The desktop window.
- class PyXA.apps.Finder.XAFinderDesktopWindow(properties)[source]
Bases:
XAFinderWindow
A class representing the containing window around Finder’s desktop element.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderDisk(properties)[source]
Bases:
XAFinderContainer
A class for managing and interacting with disks in Finder.
New in version 0.0.2.
Attributes:
The total number of bytes on the disk.
Whether the disk can be ejected.
The format of the disk, e.g. "APFS format".
The number of free bytes left on the disk.
A unique identifier for the disk that is persistent for as long as the disc is connected and Finder is running.
Whether to ignore permissions on the disk.
Whether the disk does file system journaling.
Whether the disk is a local volume vs.
Whether the disk is the boot disk.
- property capacity: int
The total number of bytes on the disk.
- property ejectable: bool
Whether the disk can be ejected.
- property format: ItemFormat
The format of the disk, e.g. “APFS format”.
- property free_space: int
The number of free bytes left on the disk.
- property id: int
A unique identifier for the disk that is persistent for as long as the disc is connected and Finder is running.
- property ignore_privileges: bool
Whether to ignore permissions on the disk.
- property journaling_enabled: bool
Whether the disk does file system journaling.
- property local_volume: bool
Whether the disk is a local volume vs. a file server.
- property startup: bool
Whether the disk is the boot disk.
- class PyXA.apps.Finder.XAFinderDiskList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderContainerList
A wrapper around lists of disks that employs fast enumeration techniques.
All properties of disks can be called as methods on the wrapped list, returning a list containing each disk’s value for the property.
New in version 0.0.3.
Methods:
by_capacity
(capacity)by_ejectable
(ejectable)by_format
(format)by_free_space
(free_space)by_id
(id)by_ignore_privileges
(ignore_privileges)by_journaling_enabled
(journaling_enabled)by_local_volume
(local_volume)by_startup
(startup)capacity
()format
()id
()startup
()- by_capacity(capacity: int) XAFinderDisk | None [source]
- by_ejectable(ejectable: bool) XAFinderDisk | None [source]
- by_format(format: ItemFormat) XAFinderDisk | None [source]
- by_free_space(free_space: int) XAFinderDisk | None [source]
- by_id(id: int) XAFinderDisk | None [source]
- by_ignore_privileges(ignore_privileges: bool) XAFinderDisk | None [source]
- by_journaling_enabled(journaling_enabled: bool) XAFinderDisk | None [source]
- by_local_volume(local_volume: bool) XAFinderDisk | None [source]
- by_startup(startup: bool) XAFinderDisk | None [source]
- format() list[ItemFormat] [source]
- class PyXA.apps.Finder.XAFinderDocumentFile(properties)[source]
Bases:
XAFinderFile
A class for managing and interacting with document files in Finder.app.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderDocumentFileList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderFileList
A wrapper around lists of document files that employs fast enumeration techniques.
All properties of document files can be called as methods on the wrapped list, returning a list containing each document file’s value for the property.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderFile(properties)[source]
Bases:
XAFinderItem
,XASBPrintable
A class for managing and interacting with files in Finder.
New in version 0.0.1.
Attributes:
The OSType of the application that created the file.
The OSType of the file and the data within it.
The version of the application the file was created with.
Whether the file is a stationery pad.
The version of the file.
- property creator_type: int
The OSType of the application that created the file.
- property file_type: int
The OSType of the file and the data within it.
- property product_version: str
The version of the application the file was created with.
- property stationery: bool
Whether the file is a stationery pad.
- property version: str
The version of the file.
- class PyXA.apps.Finder.XAFinderFileList(properties: dict, filter: dict | None = None, obj_class=None)[source]
Bases:
XAFinderItemList
A wrapper around lists of files that employs fast enumeration techniques.
All properties of files can be called as methods on the wrapped list, returning a list containing each file’s value for the property.
New in version 0.0.3.
Methods:
by_creator_type
(creator_type)by_file_type
(file_type)by_product_version
(product_version)by_stationery
(stationery)by_version
(version)version
()- by_creator_type(creator_type: int) XAFinderFile | None [source]
- by_file_type(file_type: int) XAFinderFile | None [source]
- by_product_version(product_version: str) XAFinderFile | None [source]
- by_stationery(stationery: bool) XAFinderFile | None [source]
- by_version(version: str) XAFinderFile | None [source]
- class PyXA.apps.Finder.XAFinderFinderWindow(properties)[source]
Bases:
XAFinderWindow
A class for managing and interacting with internal windows within Finder.app.
New in version 0.0.3.
Attributes:
The column view options for the container window.
The current view for the container window.
The icon view options for the container window.
The list view options for the container window.
Whether the window's path bar is visible.
The width of the sidebar in pixels.
Whether the window's status bar is visible.
The container at which this file viewer is targeted.
Whether the window's toolbar is visible.
- property column_view_options: XAFinderColumnViewOptions
The column view options for the container window.
- property current_view: ViewSetting
The current view for the container window.
- property icon_view_options: XAFinderIconViewOptions
The icon view options for the container window.
- property list_view_options: XAFinderListViewOptions
The list view options for the container window.
- property pathbar_visible: bool
Whether the window’s path bar is visible.
- property sidebar_width: int
The width of the sidebar in pixels.
- property statusbar_visible: bool
Whether the window’s status bar is visible.
- property target: XAFinderContainer
The container at which this file viewer is targeted.
- property toolbar_visible: bool
Whether the window’s toolbar is visible.
- class PyXA.apps.Finder.XAFinderFinderWindowList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderWindowList
A wrapper around lists of Finder internal windows (such as preference and information windows) that employs fast enumeration techniques.
All properties of the windows can be called as methods on the wrapped list, returning a list containing each windows’s value for the property.
New in version 0.0.3.
Methods:
by_column_view_options
(column_view_options)by_current_view
(current_view)by_icon_view_options
(icon_view_options)by_list_view_options
(list_view_options)by_pathbar_visible
(pathbar_visible)by_sidebar_width
(sidebar_width)by_statusbar_visible
(statusbar_visible)by_target
(target)by_toolbar_visible
(toolbar_visible)target
()- by_column_view_options(column_view_options: XAFinderColumnViewOptions) XAFinderFinderWindow | None [source]
- by_current_view(current_view: ViewSetting) XAFinderFinderWindow | None [source]
- by_icon_view_options(icon_view_options: XAFinderIconViewOptions) XAFinderFinderWindow | None [source]
- by_list_view_options(list_view_options: XAFinderListViewOptions) XAFinderFinderWindow | None [source]
- by_pathbar_visible(pathbar_visible: bool) XAFinderFinderWindow | None [source]
- by_sidebar_width(sidebar_width: int) XAFinderFinderWindow | None [source]
- by_statusbar_visible(statusbar_visible: bool) XAFinderFinderWindow | None [source]
- by_target(target: XAFinderContainer) XAFinderFinderWindow | None [source]
- by_toolbar_visible(toolbar_visible: bool) XAFinderFinderWindow | None [source]
- column_view_options() list[XAFinderColumnViewOptions] [source]
- current_view() list[ViewSetting] [source]
- icon_view_options() list[XAFinderIconViewOptions] [source]
- list_view_options() list[XAFinderListViewOptions] [source]
- target() XAFinderContainerList [source]
- class PyXA.apps.Finder.XAFinderFolder(properties)[source]
Bases:
XAFinderContainer
A class for managing and interacting with folders in Finder.
New in version 0.0.1.
- class PyXA.apps.Finder.XAFinderFolderList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderContainerList
A wrapper around lists of folders that employs fast enumeration techniques.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderIconViewOptions(properties)[source]
Bases:
XAObject
A class representing the icon view options of a Finder window.
New in version 0.0.3.
Attributes:
The arrangement setting of icons in icon view.
The background color of the icon view.
The background picture of the icon view.
The size of icons in icon view.
The position of a label around an icon in icon view.
Whether a preview of the icon is shown in the window.
Whether additional item information is shown in the window.
The size of text in icon view.
- property arrangement: Arrangement
The arrangement setting of icons in icon view.
- property background_picture: XAFinderFile
The background picture of the icon view.
- property icon_size: int
The size of icons in icon view.
- property label_position: LabelPosition
The position of a label around an icon in icon view.
- property shows_icon_preview: bool
Whether a preview of the icon is shown in the window.
- property shows_item_info: bool
Whether additional item information is shown in the window.
- property text_size: int
The size of text in icon view.
- class PyXA.apps.Finder.XAFinderInformationWindow(properties)[source]
Bases:
XAFinderWindow
A class for interacting with information windows in Finder.app.
New in version 0.0.3.
Attributes:
The current panel in the information window.
The item from which this window was opened.
- property item: XAFinderItem
The item from which this window was opened.
- class PyXA.apps.Finder.XAFinderInformationWindowList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderWindowList
A wrapper around lists of info windows that employs fast enumeration techniques.
All properties of info windows can be called as methods on the wrapped list, returning a list containing each window’s value for the property.
New in version 0.0.3.
Methods:
by_current_panel
(current_panel)by_item
(item)item
()- by_current_panel(current_panel: Panel) XAFinderInformationWindow | None [source]
- by_item(item: XAFinderItem) XAFinderInformationWindow | None [source]
- item() XAFinderItemList [source]
- class PyXA.apps.Finder.XAFinderInternetLocationFile(properties)[source]
Bases:
XAFinderFile
A class for managing and interacting with internet location files in Finder.app.
New in version 0.0.3.
Attributes:
The internet location.
- property location: str
The internet location.
- class PyXA.apps.Finder.XAFinderInternetLocationFileList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderFileList
A wrapper around lists of internet location files that employs fast enumeration techniques.
All properties of internet location files can be called as methods on the wrapped list, returning a list containing each file’s value for the property.
New in version 0.0.3.
Methods:
by_location
(location)location
()- by_location(location: str) XAFinderInternetLocationFile | None [source]
- class PyXA.apps.Finder.XAFinderItem(properties)[source]
Bases:
XAObject
,XASelectable
,XADeletable
,XAClipboardCodable
A generic class with methods common to the various item classes of Finder.
See also
New in version 0.0.1.
Attributes:
The bounding rectangle of an item.
The user-specified comment on the item.
The container of the item.
The date the item was created.
The description of the item.
The position of an item on the desktop.
The disk on which the item is stored.
The user-visible name of the item.
The privilege level of everyone else, e.g. "none".
Whether the file extension is hidden.
The name of the group that has access to the item.
The privilege level of the group, e.g. "write only".
The icon bitmap of the item's icon.
The index within the containing folder/disk.
The information window for this item.
The kind of the item, e.g. "Folder" or "File".
The label assigned to the item.
Whether the file is locked.
The date the item was last modified.
The name of the item.
The file extension of the item.
The name of the user that owns the item.
The privilege level of the owner, e.g. "read only".
The actual disk space used by the item.
The position of the item within the parent window.
Every property of an item.
The logical size of the item.
The URL of the item.
Methods:
copy
()Copies the item to the clipboard.
exists
()Checks whether the item exists on the disk or not.
Gets a clipboard-codable representation of the item.
move_to
(new_path[, overwrite])Moves the item to the specified path.
open
()Opens the item in its default application.
reveal
()Reveals the item in the frontmost Finder window.
- property bounds: XARectangle
The bounding rectangle of an item.
- property comment: str
The user-specified comment on the item.
- property container: XAFinderContainer
The container of the item.
- copy() XAFinderItem [source]
Copies the item to the clipboard.
- Returns:
A reference to the Finder item that called this method.
- Return type:
New in version 0.0.1.
- property creation_date: datetime
The date the item was created.
- property description: str
The description of the item.
- property disk: XAFinderDisk
The disk on which the item is stored.
- property displayed_name: str
The user-visible name of the item.
- property everyone_privileges: PrivacySetting
The privilege level of everyone else, e.g. “none”.
- exists() bool [source]
Checks whether the item exists on the disk or not.
- Returns:
True if the item exists, false otherwise.
- Return type:
bool
New in version 0.0.1.
Whether the file extension is hidden.
- get_clipboard_representation() list[str | NSURL] [source]
Gets a clipboard-codable representation of the item.
When the clipboard content is set to a Finder item, the item’s name and URL are added to the clipboard.
- Returns:
The name and URL of the item
- Return type:
list[Union[str, AppKit.NSURL]]
New in version 0.0.8.
- property group: str
The name of the group that has access to the item.
- property group_privileges: PrivacySetting
The privilege level of the group, e.g. “write only”.
- property index: int
The index within the containing folder/disk.
- property information_window: XAFinderInformationWindow
The information window for this item.
- property kind: str
The kind of the item, e.g. “Folder” or “File”.
- property label_index: int
The label assigned to the item.
- property locked: bool
Whether the file is locked.
- property modification_date: datetime
The date the item was last modified.
- move_to(new_path: str | NSURL, overwrite: bool = False) XAFinderItem [source]
Moves the item to the specified path.
- Parameters:
new_path (Union[str, AppKit.NSURL]) – The path to move the item to.
overwrite (bool, optional) – Whether to overwrite existing files of the same name at the target path, defaults to False
- Returns:
A reference to the Finder item that called this method.
- Return type:
New in version 0.0.1.
- property name: str
The name of the item.
- property name_extension: str
The file extension of the item.
- property owner: str
The name of the user that owns the item.
- property owner_privileges: PrivacySetting
The privilege level of the owner, e.g. “read only”.
- property physical_size: int
The actual disk space used by the item.
- property properties: dict
Every property of an item.
- reveal() XAFinderItem [source]
Reveals the item in the frontmost Finder window.
- Returns:
A reference to the item object
- Return type:
New in version 0.0.4.
- property size: int
The logical size of the item.
- class PyXA.apps.Finder.XAFinderItemList(properties: dict, filter: dict | None = None, object_class=None)[source]
Bases:
XAList
A wrapper around lists of Finder items that employs fast enumeration techniques.
All properties of Finder items can be called as methods on the wrapped list, returning a list containing each item’s value for the property.
New in version 0.0.3.
Methods:
bounds
()by_bounds
(bounds)by_comment
(comment)by_container
(container)by_creation_date
(creation_date)by_description
(description)by_desktop_position
(desktop_position)by_disk
(disk)by_displayed_name
(displayed_name)by_everyone_privileges
(everyone_privileges)by_extension_hidden
(extension_hidden)by_group
(group)by_group_privileges
(group_privileges)by_icon
(icon)by_index
(index)by_information_window
(information_window)by_kind
(kind)by_label_index
(label_index)by_locked
(locked)by_modification_date
(modification_date)by_name
(name)by_name_extension
(name_extension)by_owner
(owner)by_owner_privileges
(owner_privileges)by_physical_size
(physical_size)by_position
(position)by_size
(size)by_url
(url)comment
()disk
()Gets a clipboard-codable representation of each item in the list.
group
()icon
()index
()Returns the index of the first occurrence of the element in the list, or -1 if no such element exists in the list.
kind
()locked
()name
()owner
()position
()size
()url
()- by_bounds(bounds: tuple[tuple[int, int], tuple[int, int]]) XAFinderItem | None [source]
- by_comment(comment: str) XAFinderItem | None [source]
- by_container(container: XAFinderContainer) XAFinderItem | None [source]
- by_creation_date(creation_date: datetime) XAFinderItem | None [source]
- by_description(description: str) XAFinderItem | None [source]
- by_desktop_position(desktop_position: tuple[int, int]) XAFinderItem | None [source]
- by_disk(disk: XAFinderDisk) XAFinderItem | None [source]
- by_displayed_name(displayed_name: str) XAFinderItem | None [source]
- by_everyone_privileges(everyone_privileges: PrivacySetting) XAFinderItem | None [source]
- by_group(group: str) XAFinderItem | None [source]
- by_group_privileges(group_privileges: PrivacySetting) XAFinderItem | None [source]
- by_icon(icon: XAImage) XAFinderItem | None [source]
- by_index(index: int) XAFinderItem | None [source]
- by_information_window(information_window: XAFinderInformationWindow) XAFinderItem | None [source]
- by_kind(kind: str) XAFinderItem | None [source]
- by_label_index(label_index: index) XAFinderItem | None [source]
- by_locked(locked: bool) XAFinderItem | None [source]
- by_modification_date(modification_date: datetime) XAFinderItem | None [source]
- by_name(name: str) XAFinderItem | None [source]
- by_name_extension(name_extension: str) XAFinderItem | None [source]
- by_owner(owner: str) XAFinderItem | None [source]
- by_owner_privileges(owner_privileges: PrivacySetting) XAFinderItem | None [source]
- by_physical_size(physical_size: int) XAFinderItem | None [source]
- by_position(position: tuple[int, int]) XAFinderItem | None [source]
- by_size(size: int) XAFinderItem | None [source]
- by_url(url: str | XAPath) XAFinderItem | None [source]
- container() XAFinderContainerList [source]
- disk() XAFinderDiskList [source]
- everyone_privileges() list[PrivacySetting] [source]
- get_clipboard_representation() list[str | NSURL] [source]
Gets a clipboard-codable representation of each item in the list.
When the clipboard content is set to a list of Finder items, each item’s name and URL are added to the clipboard.
- Returns:
The name and URL of each item in the list
- Return type:
list[Union[str, AppKit.NSURL]]
New in version 0.0.8.
- group_privileges() list[PrivacySetting] [source]
- icon() XAImageList [source]
- index() list[int] [source]
Returns the index of the first occurrence of the element in the list, or -1 if no such element exists in the list.
New in version 0.1.2.
- information_window() XAFinderInformationWindowList [source]
- owner_privileges() list[PrivacySetting] [source]
- class PyXA.apps.Finder.XAFinderListViewOptions(properties)[source]
Bases:
XAObject
A class representing the list view options in a Finder window.
New in version 0.0.3.
Attributes:
Whether folder sizes are calculated and displayed in the window.
The size of icons in the window.
Whether a preview of the item is shown in the window.
The column that the list view is sorted on.
The size of text in the window.
Whether relative dates are shown in the window.
Methods:
columns
([filter])Returns a list of columns matching the filter.
- property calculates_folder_sizes: bool
Whether folder sizes are calculated and displayed in the window.
- columns(filter: dict | None = None) XAFinderColumnList [source]
Returns a list of columns matching the filter.
New in version 0.0.3.
- property shows_icon_preview: bool
Whether a preview of the item is shown in the window.
- property sort_column: XAFinderColumn
The column that the list view is sorted on.
- property text_size: int
The size of text in the window.
- property uses_relative_dates: bool
Whether relative dates are shown in the window.
- class PyXA.apps.Finder.XAFinderPackage(properties)[source]
Bases:
XAFinderItem
A class for managing and interacting with packages in Finder.app.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderPackageList(properties: dict, filter: dict | None = None)[source]
Bases:
XAFinderItemList
A wrapper around lists of packages that employs fast enumeration techniques.
All properties of packages can be called as methods on the wrapped list, returning a list containing each package’s value for the property.
New in version 0.0.3.
- class PyXA.apps.Finder.XAFinderPreferences(properties)[source]
Bases:
XAFinderItem
,XASBPrintable
A class for managing general preferences of Finder.app.
New in version 0.0.3.
Attributes:
Whether all name extensions are shown regardless of the "extension hidden" setting.
The default column view options.
The delay, in seconds, before springing open folders.
Whether connected servers appear on the desktop.
Whether external hard disks appear on the desktop.
Whether hard drives appear on the desktop.
Whether CDs, DVDs, and iPods appear on the desktop.
Whether folders open into new tabs.
Whether folders open into new windows.
Whether folders spring open after a delay.
The default icon view options.
The default list view options.
The target location for a newly opened Finder window.
Whether new Finder windows open in column view.
The Finder preferences window.
- property all_name_extensions_showing: bool
Whether all name extensions are shown regardless of the “extension hidden” setting.
- property column_view_options: XAFinderColumnViewOptions
The default column view options.
- property delay_before_springing: bool
The delay, in seconds, before springing open folders.
- property desktop_shows_connected_servers: bool
Whether connected servers appear on the desktop.
- property desktop_shows_external_hard_disks: bool
Whether external hard disks appear on the desktop.
- property desktop_shows_hard_disks: bool
Whether hard drives appear on the desktop.
- property desktop_shows_removable_media: bool
Whether CDs, DVDs, and iPods appear on the desktop.
- property folders_open_in_new_tabs: bool
Whether folders open into new tabs.
- property folders_open_in_new_windows: bool
Whether folders open into new windows.
- property folders_spring_open: bool
Whether folders spring open after a delay.
- property icon_view_options: XAFinderIconViewOptions
The default icon view options.
- property list_view_options: XAFinderListViewOptions
The default list view options.
- property new_window_target: XAFinderAliasFile
The target location for a newly opened Finder window.
- property new_windows_open_in_column_view: bool
Whether new Finder windows open in column view.
- property window: bool
The Finder preferences window.
- class PyXA.apps.Finder.XAFinderPreferencesWindow(properties)[source]
Bases:
XAFinderWindow
A class for managing and interacting with preference windows in Finder.app.
New in version 0.0.3.
Attributes:
The current panel in the Finder preferences window.
- class PyXA.apps.Finder.XAFinderTrash(properties)[source]
Bases:
XAFinderContainer
A class for managing and interacting with Finder’s Trash.
New in version 0.0.2.
Attributes:
Whether to display a dialog before emptying the Trash.
- property warns_before_emptying: bool
Whether to display a dialog before emptying the Trash.
- class PyXA.apps.Finder.XAFinderWindow(properties)[source]
Bases:
XASBWindow
,XASBPrintable
A class for managing and interacting with windows of Finder.app.
- Example 1:
Setting the bounds of a Finder window
>>> import PyXA >>> app = PyXA.Application("Finder") >>> window = app.windows()[0] >>> lock = False >>> (old_w, old_h) = (0,0) >>> while True: >>> if window.position.y < 50 and lock is False: >>> # Increase height of window when user drags it to the top >>> (old_w, old_h) = window.bounds.size >>> (x, y) = window.position >>> window.set_property("bounds", ((x, y), (old_w, 2000))) >>> lock = True >>> if lock is True and window.position.y > 55: >>> # Return to original size if user moves window down >>> (x, y) = window.position >>> window.set_property("bounds", ((x, y), (old_w, old_h))) >>> lock = False
New in version 0.0.3.
Attributes:
Whether the window is collapsed.
Whether the window floats.
Whether the window is modal.
The upper left position of the window.
Every property of a Finder window.
Whether the window has a title bar.
- property collapsed: bool
Whether the window is collapsed.
- property floating: bool
Whether the window floats.
- property modal: bool
Whether the window is modal.
- property properties: dict
Every property of a Finder window.
- property titled: bool
Whether the window has a title bar.
- class PyXA.apps.Finder.XAFinderWindowList(properties: dict, filter: dict | None = None, obj_class=None)[source]
Bases:
XASBWindowList
A wrapper around lists of Finder windows that employs fast enumeration techniques.
All properties of Finder windows can be called as methods on the wrapped list, returning a list containing each window’s value for the property.
New in version 0.0.3.
Methods:
by_collapsed
(collapsed)by_floating
(floating)by_modal
(modal)by_position
(position)by_properties
(properties)by_titled
(titled)floating
()modal
()position
()titled
()- by_collapsed(collapsed: bool) XAFinderWindow | None [source]
- by_floating(floating: bool) XAFinderWindow | None [source]
- by_modal(modal: bool) XAFinderWindow | None [source]
- by_position(position: tuple[int, int]) XAFinderWindow | None [source]
- by_properties(properties: dict) XAFinderWindow | None [source]
- by_titled(titled: bool) XAFinderWindow | None [source]