Skip to content

GitLab

Closed
Created by Miro Hrončok@hroncokContributor

pyatspi is not Python 3.7 compatible due to using "async" as a attribute/argument name

pyatspi uses "async" as a attribute/argument name:

https://github.com/GNOME/pyatspi2/blob/150e7b386736d41ed3b95a5d691879e0a3246f57/pyatspi/registry.py#L114 https://gitlab.gnome.org/GNOME/pyatspi2/blob/150e7b386736d41ed3b95a5d691879e0a3246f57/pyatspi/registry.py#L114 (and below that as well).

This results in:

  File "/usr/lib/python3.7/site-packages/pyatspi/registry.py", line 114
    self.async = False	# not fully supported yet
             ^
SyntaxError: invalid syntax

https://docs.python.org/3/whatsnew/3.7.html#summary-release-highlights

Fedora reproducer: fedpkg build --target=f29-python -> https://koji.fedoraproject.org/koji/taskinfo?taskID=27887876

This needs to be renamed. But it kinda seems like part of an API, if that's true, it's a good idea to provide a backwards compatible API as well. I have a decorator that might be useful for this (consider it Public Domain or CC0):

from functools import wraps


def deprecated_async(func):
    """A decorator, that let's us keep our old API, but deprecate it"""
    @wraps(func)
    def inner(*args, **kwargs):
        if 'async' in kwargs:
            if 'asynchronous' in kwargs:
                raise ValueError('cannot use both async and asynchronous '
                                 'keyword arguments! the latter obsoletes the first.')
            warnings.warn('async keyword argumnt is deprecated, '
                          'use asynchronous instead', DeprecationWarning)
            kwargs['asynchronous'] = kwargs.pop('async')
        return func(*args, **kwargs)
    return inner


@deprecated_async
def awesome_func(foo, bar, asynchronous=False):
    """People can pass async or asynchronous"""
    ...

Fedora bug for cross reference: https://bugzilla.redhat.com/show_bug.cgi?id=1596269

Edited by Miro Hrončok