dogtail 2.0.dev2__tar.gz → 2.0.dev4__tar.gz

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/.gitlab-ci.yml

@@ -17,7 +17,7 @@ lint_code:
   script:
     - pip install ruff
     - ruff check .
-    - python -m compileall dogtail/ scripts/
+    - python -m compileall dogtail/
   only:
     - tags
     - branches
@@ -101,3 +101,5 @@ publish-index:
     paths:
       - dist
     when: always
+  # Maybe lets only do this manually, not sure if this is needed for every commit.
+  when: manual

dogtail-2.0.dev2/ChangeLog → dogtail-2.0.dev4/CHANGES

@@ -1,6 +1,34 @@
+2024-10-29 Michal Odehnal <modehnal@redhat.com>
+
+	dogtail 2.0.dev2
+	================
+	Tracked in Issue #29
+	Remove obsolete and legacy code that I have not observed in usage for many years while working with dogtail and automation in general.
+	Improve Wayland support, iron out some wrinkles in very specific corner cases.
+	Improving code structure and moving specific parts to its own files to improve readability in high level Node.
+	Remove all pyatspi2 usage, switching to only Atspi usage.
+	Adding accessibility classes, which were heavily inspired by Orca.
+	Logging was rewritten to be more useful.
+	The ponytail handling was rewritten and added to its own file, so it is not implemented in several files.
+	Printing Accessibility Structure Representation with dump and tree was improved in readability and efficiency.
+	Configuration handling was improved and ability to have config file per project was added.
+	Changing casing to snake_case, but still have backwards compatibility to camelCase.
+	Custom keys and values - users can define their own config values in .ini file.
+	Type checking: users will get ValueError when trying to set e.g. bool to value defined as float in config.ini.
+	Unittests were rewritten and their execution have been validated with testing-farm. These will now execute before every MR.
+	Examples were updated.
+	Removing Sniff, I will not release dogtail with Sniff in a broken state. It is not working well under Wayland and effort to rewrite it would be great. If someone is willing to rewrite it and improve it I will accept MR with it. Until then there are better tools that fullfil the same role.
+	Preparation for Newton was added to Accessible classes, currently switched off.
+	Preparation for documentation is also present as docstring in class methods, but not executed upon yet. For now one of my colleagues said he will take a look, if not, I will do it myself later.
+	README file was updated with up to date information.
+	Released version 2.0.dev2 to pypi which is ready to be used by wider audience.
+	Metadata updated where possible.
+	The dogtail.spec and Makefile remain mostly untouched. I have never used those, adapting those should come from someone more knowledgeable.
+
+
 2024-12-31 Michal Odehnal <modehnal@redhat.com>
 
-	dogtail 2.0
+	dogtail 2.x
 	===========
 	See the NEWS file for all changes.
 

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/NEWS

@@ -1,19 +1,25 @@
 dogtail-2.0
 ===========
 
-- Remove obsolete and legacy code that was never used in my several years of heavy dogtail usage.
+- Tracked in Issue #29
+- Remove obsolete and legacy code that I have not observed in usage for several years, working with dogtail and automation in general.
+- Improve Wayland support, iron out some wrinkles in very specific corner cases.
 - Improving code structure and moving specific parts to its own files to improve readability in high level Node.
-- Remove all pyatspi2 usage and switch to only Atspi usage.
-- Introduction of accessibility classes, which were heavily inspired by Orca to solve problems with Accessibility when required.
-- Logging was remade to be more useful.
-- Ponytail now has its own file, so it is not sprinkled all over the code.
-- Dumping Accessibility Structure Representation with dump and tree was improved.
-- Config file was improved and ability to have a config file specific for a project was added.
+- Remove all pyatspi2 usage, switching to only Atspi usage.
+- Adding accessibility classes, which were heavily inspired by Orca.
+- Logging was rewritten to be more useful.
+- The ponytail handling was rewritten and added to its own file, so it is not implemented in several files.
+- Printing Accessibility Structure Representation with dump and tree was improved in readability and efficiency.
+- Configuration handling was improved and ability to have config file per project was added.
 - Changing casing to snake_case, but still have backwards compatibility to camelCase.
 - Custom keys and values - users can define their own config values in .ini file.
 - Type checking: users will get ValueError when trying to set e.g. bool to value defined as float in config.ini.
-- Release to pypi.
-
+- Unittests were rewritten and their execution have been validated with testing-farm. These will now execute before every MR.
+- Examples were updated.
+- Removing Sniff, I will not release dogtail with Sniff in a broken state. It is not working well under Wayland and effort to rewrite it would be great. If someone is willing to rewrite it and improve it I will accept MR with it. Until then there are better tools that fullfil the same role.
+- Preparation for Newton was added to Accessible classes, currently switched off.
+- Preparation for documentation is also present as docstring in class methods, but not executed upon yet. For now one of my colleagues said he will take a look, if not, I will do it myself later.
+- README file was updated with up to date information.
 
 
 dogtail 1.0

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dogtail
-Version: 2.0.dev2
+Version: 2.0.dev4
 Summary: GUI test tool and automation framework that uses Accessibility (AT-SPI) technologies to communicate with desktop applications.
 Author-email: Zack Cerza <zcerza@redhat.com>, Ed Rousseau <rousseau@redhat.com>, David Malcolm <dmalcolm@redhat.com>, Vitezslav Humpa <vhumpa@redhat.com>, Michal Odehnal <modehnal@redhat.com>
 License-Expression: GPL-2.0
@@ -23,7 +23,6 @@ Other than that, dogtail should work with any desktop environment that still run
 
 # News
 
-
 ## Release of dogtail-2.x
 
 Detailed information can be found in issue https://gitlab.com/dogtail/dogtail/-/issues/29.
@@ -122,10 +121,11 @@ Disabling Shadows in GTK4:
 
 To disable window shadows, add the following CSS to your GTK4 configuration (`~/.config/gtk-4.0/gtk.css`):
 
+```
 window, .popover, .tooltip {
     box-shadow: none;
 }
-
+```
 
 # Using
 
@@ -168,6 +168,21 @@ API Documentation:
 We have deprecated our mailing lists as well as IRC channel. Please use our GitLab for issues and merge requests! (Or possibly https://github.com/vhumpa/dogtail perhaps for your pull requests should you prefer to use github, but gitlab.com is preferred)
 
 
+# Contributing
+
+- **Bug Reports**: If you find a bug, check if an [issue](https://gitlab.com/dogtail/dogtail/issues) already exists. If not, please open one with a clear description and steps to reproduce it.
+
+- **Feature Ideas**: Have a great idea? Open an [issue](https://gitlab.com/dogtail/dogtail/issues) to discuss it. This helps us align on the goal before you write any code.
+
+- **Ready to Help**? Look for existing [issues](https://gitlab.com/dogtail/dogtail/issues). If you see one you'd like to work on, just leave a comment to let us know!
+
+There are a few ways I would like to preserve the readability of the code.
+
+- For functions and methods, use docstring to explain what it does, this way we can be sure it gets in the documentation.
+- Use correct casing for classes, methods and variables. Most of the code base uses *snake_case*.
+- Use full names for variables where possible. Single letter variables are not acceptable.
+- Comments are sentences, they start with a capital letter and end with a dot.
+
 # Version dogtail-1.x
 
 The [dogtail-1.x](https://gitlab.com/dogtail/dogtail/-/tree/dogtail-1.x) is still available and if required will be updated and new versions will be released.

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/README.md

@@ -9,7 +9,6 @@ Other than that, dogtail should work with any desktop environment that still run
 
 # News
 
-
 ## Release of dogtail-2.x
 
 Detailed information can be found in issue https://gitlab.com/dogtail/dogtail/-/issues/29.
@@ -108,10 +107,11 @@ Disabling Shadows in GTK4:
 
 To disable window shadows, add the following CSS to your GTK4 configuration (`~/.config/gtk-4.0/gtk.css`):
 
+```
 window, .popover, .tooltip {
     box-shadow: none;
 }
-
+```
 
 # Using
 
@@ -154,6 +154,21 @@ API Documentation:
 We have deprecated our mailing lists as well as IRC channel. Please use our GitLab for issues and merge requests! (Or possibly https://github.com/vhumpa/dogtail perhaps for your pull requests should you prefer to use github, but gitlab.com is preferred)
 
 
+# Contributing
+
+- **Bug Reports**: If you find a bug, check if an [issue](https://gitlab.com/dogtail/dogtail/issues) already exists. If not, please open one with a clear description and steps to reproduce it.
+
+- **Feature Ideas**: Have a great idea? Open an [issue](https://gitlab.com/dogtail/dogtail/issues) to discuss it. This helps us align on the goal before you write any code.
+
+- **Ready to Help**? Look for existing [issues](https://gitlab.com/dogtail/dogtail/issues). If you see one you'd like to work on, just leave a comment to let us know!
+
+There are a few ways I would like to preserve the readability of the code.
+
+- For functions and methods, use docstring to explain what it does, this way we can be sure it gets in the documentation.
+- Use correct casing for classes, methods and variables. Most of the code base uses *snake_case*.
+- Use full names for variables where possible. Single letter variables are not acceptable.
+- Comments are sentences, they start with a capital letter and end with a dot.
+
 # Version dogtail-1.x
 
 The [dogtail-1.x](https://gitlab.com/dogtail/dogtail/-/tree/dogtail-1.x) is still available and if required will be updated and new versions will be released.

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/dogtail/predicate.py

@@ -148,12 +148,12 @@ class GenericPredicate:
         """
 
         string_to_represent_object = ""
-        string_to_represent_object += f"name:'{self.name if self.name else 'None'}' "
-        string_to_represent_object += f"role_name:'{self.role_name if self.role_name else 'None'}' "
-        string_to_represent_object += f"description:'{self.description if self.description else 'None'}' "
-        string_to_represent_object += f"label:'{self.label if self.label else 'None'}' "
-        string_to_represent_object += f"id:'{self.identifier if self.identifier else 'None'}' "
-        string_to_represent_object += f"showing_only:'{self.showing_only if self.showing_only else 'None'}'"
+        string_to_represent_object += f"name:'{repr(self.name)}' "
+        string_to_represent_object += f"role_name:'{repr(self.role_name)}' "
+        string_to_represent_object += f"description:'{repr(self.description)}' "
+        string_to_represent_object += f"label:'{repr(self.label)}' "
+        string_to_represent_object += f"id:'{repr(self.identifier)}' "
+        string_to_represent_object += f"showing_only:'{repr(self.showing_only)}'"
         return string_to_represent_object
 
 

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/dogtail/tree.py

@@ -2428,6 +2428,15 @@ class Node(object):
             showing_only=showingOnly
         )
 
+
+    def findAncestor(self, predicate, retry=True): # pylint: disable=invalid-name
+        """
+        For backwards compatibility reasons. Wrapper for self.find_ancestor.
+        """
+
+        return self.find_ancestor(predicate, retry=retry)
+
+
     def findChild(self, predicate, retry=True): # pylint: disable=invalid-name
         """
         For backwards compatibility reasons. Wrapper for self.find_child.
@@ -2587,3 +2596,15 @@ try:
 except AttributeError:
     # Might be already deleted.
     pass
+
+try:
+    del Atspi.Accessible.description
+except AttributeError:
+    # Might be already deleted.
+    pass
+
+try:
+    del Atspi.Accessible.attributes
+except AttributeError:
+    # Might be already deleted.
+    pass

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/dogtail.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dogtail
-Version: 2.0.dev2
+Version: 2.0.dev4
 Summary: GUI test tool and automation framework that uses Accessibility (AT-SPI) technologies to communicate with desktop applications.
 Author-email: Zack Cerza <zcerza@redhat.com>, Ed Rousseau <rousseau@redhat.com>, David Malcolm <dmalcolm@redhat.com>, Vitezslav Humpa <vhumpa@redhat.com>, Michal Odehnal <modehnal@redhat.com>
 License-Expression: GPL-2.0
@@ -23,7 +23,6 @@ Other than that, dogtail should work with any desktop environment that still run
 
 # News
 
-
 ## Release of dogtail-2.x
 
 Detailed information can be found in issue https://gitlab.com/dogtail/dogtail/-/issues/29.
@@ -122,10 +121,11 @@ Disabling Shadows in GTK4:
 
 To disable window shadows, add the following CSS to your GTK4 configuration (`~/.config/gtk-4.0/gtk.css`):
 
+```
 window, .popover, .tooltip {
     box-shadow: none;
 }
-
+```
 
 # Using
 
@@ -168,6 +168,21 @@ API Documentation:
 We have deprecated our mailing lists as well as IRC channel. Please use our GitLab for issues and merge requests! (Or possibly https://github.com/vhumpa/dogtail perhaps for your pull requests should you prefer to use github, but gitlab.com is preferred)
 
 
+# Contributing
+
+- **Bug Reports**: If you find a bug, check if an [issue](https://gitlab.com/dogtail/dogtail/issues) already exists. If not, please open one with a clear description and steps to reproduce it.
+
+- **Feature Ideas**: Have a great idea? Open an [issue](https://gitlab.com/dogtail/dogtail/issues) to discuss it. This helps us align on the goal before you write any code.
+
+- **Ready to Help**? Look for existing [issues](https://gitlab.com/dogtail/dogtail/issues). If you see one you'd like to work on, just leave a comment to let us know!
+
+There are a few ways I would like to preserve the readability of the code.
+
+- For functions and methods, use docstring to explain what it does, this way we can be sure it gets in the documentation.
+- Use correct casing for classes, methods and variables. Most of the code base uses *snake_case*.
+- Use full names for variables where possible. Single letter variables are not acceptable.
+- Comments are sentences, they start with a capital letter and end with a dot.
+
 # Version dogtail-1.x
 
 The [dogtail-1.x](https://gitlab.com/dogtail/dogtail/-/tree/dogtail-1.x) is still available and if required will be updated and new versions will be released.

{dogtail-2.0.dev2 → dogtail-2.0.dev4}/dogtail.egg-info/SOURCES.txt

@@ -1,8 +1,8 @@
 .gitignore
 .gitlab-ci.yml
 .packit.yaml
+CHANGES
 COPYING
-ChangeLog
 MAINTAINERS
 Makefile
 NEWS