Tips & Tricks¶
Here are a few ways to simplify consumer definitions.
Decorating All Request Methods in a Class¶
To apply a decorator across all methods in a class, you can simply decorate the class rather than each method individually:
@uplink.timeout(60)
class GitHub(uplink.Consumer):
@uplink.get("/repositories")
def get_repos(self):
"""Dump every public repository."""
@uplink.get("/organizations")
def get_organizations(self):
"""List all organizations."""
Hence, the consumer defined above is equivalent to the following, slightly more verbose definition:
class GitHub(uplink.Consumer):
@uplink.timeout(60)
@uplink.get("/repositories")
def get_repos(self):
"""Dump every public repository."""
@uplink.timeout(60)
@uplink.get("/organizations")
def get_organizations(self):
"""List all organizations."""
Adopting the Argument’s Name¶
Several function argument annotations accept a name
parameter
on construction. For instance, the Path
annotation
uses the name
parameter to associate the function argument to
a URI path parameter:
class GitHub(uplink.Consumer):
@uplink.get("users/{username}")
def get_user(self, username: uplink.Path("username")): pass
For such annotations, you can omit the name
parameter to have the
annotation adopt the name of its corresponding method argument.
For instance, from the previous example, we can omit naming the
Path
annotation since the corresponding argument’s
name, username
, matches the intended URI path parameter.
class GitHub(uplink.Consumer):
@uplink.get("users/{username}")
def get_user(self, username: uplink.Path): pass
Some annotations that support this behavior include:
Path
, uplink.Field
, Part
Header
, and uplink.Query
.
Annotating Your Arguments For Python 2.7¶
There are several ways to annotate arguments. Most examples in this
documentation use function annotations, but this approach is unavailable
for Python 2.7 users. Instead, you should either utilize the method
annotation args
or use the optional args
parameter of the HTTP method decorators (e.g., uplink.get
).
Using uplink.args
¶
One approach for Python 2.7 users involves using the method annotation
args
, arranging annotations in the same order as
their corresponding function arguments (again, ignore self
):
class GitHub(uplink.Consumer):
@uplink.args(uplink.Url, uplink.Path)
@uplink.get
def get_commit(self, commits_url, sha): pass
The args
argument¶
New in version v0.5.0.
The HTTP method decorators (e.g., uplink.get
) support an
optional positional argument args
, which accepts a
list of annotations, arranged in the same order as their corresponding
function arguments,
class GitHub(uplink.Consumer):
@uplink.get(args=(uplink.Url, uplink.Path))
def get_commit(self, commits_url, sha): pass
or a mapping of argument names to annotations:
class GitHub(uplink.Consumer):
@uplink.get(args={"commits_url": uplink.Url, "sha": uplink.Path})
def get_commit(self, commits_url, sha): pass