Basic type support #239

chadrik · 2017-08-28T05:02:44Z

Added Attribute.type, which gets its value from attribute __annotations__ in python 3.6+ or a newly added type argument to attr.ib().

This is a prerequisite for runtime and static type-checking, as discussed in #215.

…om PEP526-style annotations.

codecov · 2017-08-28T05:09:20Z

Codecov Report

Merging #239 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master   #239   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           9      9           
  Lines         604    612    +8     
  Branches      133    135    +2     
=====================================
+ Hits          604    612    +8

Impacted Files	Coverage Δ
src/attr/_make.py	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0d04d5e...0168ab8. Read the comment docs.

hynek

The stylistic comments apart it looks mostly fine to me.

It needs a news fragment tho.

Since I'm leaving tomorrow, I’ll leave this to 👑 @Tinche 👑 to see it through the end. :)

src/attr/_make.py

@@ -125,10 +125,16 @@ def attr(default=NOTHING, validator=None,
 value is converted before being passed to the validator, if any.
 :param metadata: An arbitrary mapping, to be used by third-party
 components. See :ref:`extending_metadata`.
+ :param type: The type of the attribute. In python 3.6 or greater, the


src/attr/_make.py

@@ -191,8 +198,11 @@ def _transform_attrs(cls, these):
 for name, ca
 in iteritems(these)]

+ ann = getattr(cls, '__annotations__', {})


src/attr/_make.py

+ if type is None:
+ type = ca.type
+ elif ca.type is not None and type is not ca.type:
+ raise ValueError(


tests/test_make.py

+ x = attr(type=int)
+ y = attr(type=str)
+ z = attr()
+ assert int is C.__attrs_attrs__[0].type


tox.ini

@@ -18,7 +18,7 @@ commands = coverage run --parallel -m pytest {posargs}

 [testenv:py36]
 deps = -rdev-requirements.txt
-commands = coverage run --parallel -m pytest {posargs}
+commands = coverage run --parallel -m pytest {posargs} tests/_test_annotations.py


tests/_test_annotations.py

@@ -0,0 +1,67 @@
+"""
+Tests for python 3 type annotations.


src/attr/_make.py

@@ -125,10 +125,16 @@ def attr(default=NOTHING, validator=None,
 value is converted before being passed to the validator, if any.
 :param metadata: An arbitrary mapping, to be used by third-party
 components. See :ref:`extending_metadata`.
+ :param type: The type of the attribute. In Python 3.6 or greater, the
+ preferred method to specify the type is using a variable annotation
+ (see PEP-526 ). This argument is provided for backward compatibility.


chadrik · 2017-08-30T17:09:39Z

All notes addressed (as of 11 minutes ago), and added the changelog fragment.

hynek

Some more bike shedding but I’m out now. :)

Oh and flake8 is failing.

changelog.d/239.change.rst

@@ -0,0 +1,3 @@
+Added ``type`` argument to ``attr.attr()`` and corresponding ``type`` attribute to ``attr.Attribute``.


changelog.d/239.change.rst

@@ -0,0 +1,3 @@
+Added ``type`` argument to ``attr.attr()`` and corresponding ``type`` attribute to ``attr.Attribute``.
+This value can be inspected by third-party tools for type checking and serialization.


src/attr/_make.py

+ type = ca.type
+ elif ca.type is not None:
+ raise ValueError(
+ "Type annotation and type argument are both present: "


Tinche · 2017-08-30T20:03:12Z

@hynek Roger, I'll put this into my queue.

src/attr/_make.py


 .. versionchanged:: 17.1.0 *validator* can be a ``list`` now.
 .. versionchanged:: 17.1.0
 *hash* is ``None`` and therefore mirrors *cmp* by default .
+ .. versionadded:: 17.3.0 *type*


Tinche

This looks good to me!

src/attr/_make.py


 .. versionchanged:: 17.1.0 *validator* can be a ``list`` now.
 .. versionchanged:: 17.1.0
 *hash* is ``None`` and therefore mirrors *cmp* by default .
+ .. versionadded:: 17.3.0 *type*


Tinche · 2017-09-13T19:53:32Z

It's still showing @hynek as requesting some changes, but I can't figure out exactly what. I think all comments have been addressed?

wsanchez · 2017-09-13T20:22:43Z

@Tinche: Github is kinda lame about review process workflow, and this looks a lot like one of the ways it's lame.

This is great, BTW.

Tinche · 2017-09-17T14:22:58Z

In you go!

Tinche · 2017-09-17T15:15:31Z

Thank you for your contribution.

chadrik · 2017-09-17T17:36:59Z

It's been a pleasure. You all run a very tight ship here. I like it.

Head up: I'll be rebasing #238 against this change soon, and pushing that PR along.

167: Scheduled weekly dependency update for week 46 r=mithrandi ## Updates Here's a list of all the updates bundled in this pull request. I've added some links to make it easier for you to find all the information you need. <table align="center"> <tr> <td><b>attrs</b></td> <td align="center">17.2.0</td> <td align="center">»</td> <td align="center">17.3.0</td> <td> <a href="https://pypi.python.org/pypi/attrs">PyPI</a> | <a href="https://pyup.io/changelogs/attrs/">Changelog</a> | <a href="http://www.attrs.org/">Homepage</a> </td> <tr> <td><b>cryptography</b></td> <td align="center">2.1.2</td> <td align="center">»</td> <td align="center">2.1.3</td> <td> <a href="https://pypi.python.org/pypi/cryptography">PyPI</a> | <a href="https://pyup.io/changelogs/cryptography/">Changelog</a> | <a href="https:/pyca/cryptography">Repo</a> </td> <tr> <td><b>hypothesis</b></td> <td align="center">3.33.0</td> <td align="center">»</td> <td align="center">3.37.0</td> <td> <a href="https://pypi.python.org/pypi/hypothesis">PyPI</a> | <a href="https://pyup.io/changelogs/hypothesis/">Changelog</a> | <a href="https:/HypothesisWorks/hypothesis/issues">Repo</a> </td> </tr> </table> ## Changelogs ### attrs 17.2.0 -> 17.3.0 >### 17.3.0 >------------------- >Backward-incompatible Changes >^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ >- Attributes are not defined on the class body anymore. > This means that if you define a class ``C`` with an attribute ``x``, the class will *not* have an attribute ``x`` for introspection anymore. > Instead of ``C.x``, use ``attr.fields(C).x`` or look at ``C.__attrs_attrs__``. > The old behavior has been deprecated since version 16.1. > (`253 <https:/python-attrs/attrs/issues/253>`_) >Changes >^^^^^^^ >- ``super()`` and ``__class__`` now work on Python 3 when ``slots=True``. > (`102 <https:/python-attrs/attrs/issues/102>`_, `226 <https:/python-attrs/attrs/issues/226>`_, `269 <https:/python-attrs/attrs/issues/269>`_, `270 <https:/python-attrs/attrs/issues/270>`_, `272 <https:/python-attrs/attrs/issues/272>`_) >- Added ``type`` argument to ``attr.ib()`` and corresponding ``type`` attribute to ``attr.Attribute``. > This change paves the way for automatic type checking and serialization (though as of this release ``attrs`` does not make use of it). > In Python 3.6 or higher, the value of ``attr.Attribute.type`` can alternately be set using variable type annotations > (see `PEP 526 <https://www.python.org/dev/peps/pep-0526/>`_). (`151 <https:/python-attrs/attrs/issues/151>`_, `214 <https:/python-attrs/attrs/issues/214>`_, `215 <https:/python-attrs/attrs/issues/215>`_, `239 <https:/python-attrs/attrs/issues/239>`_) >- The combination of ``str=True`` and ``slots=True`` now works on Python 2. > (`198 <https:/python-attrs/attrs/issues/198>`_) >- ``attr.Factory`` is hashable again. (`204 > <https:/python-attrs/attrs/issues/204>`_) >- Subclasses now can overwrite attribute definitions of their superclass. > That means that you can -- for example -- change the default value for an attribute by redefining it. > (`221 <https:/python-attrs/attrs/issues/221>`_, `229 <https:/python-attrs/attrs/issues/229>`_) >- Added new option ``auto_attribs`` to ``attr.s`` that allows to collect annotated fields without setting them to ``attr.ib()``. > Setting a field to an ``attr.ib()`` is still possible to supply options like validators. > Setting it to any other value is treated like it was passed as ``attr.ib(default=value)`` -- passing an instance of ``attr.Factory`` also works as expected. > (`262 <https:/python-attrs/attrs/issues/262>`_, `277 <https:/python-attrs/attrs/issues/277>`_) >- Instances of classes created using ``attr.make_class()`` can now be pickled. > (`282 <https:/python-attrs/attrs/issues/282>`_) >---- ### hypothesis 3.33.0 -> 3.37.0 >### 3.37.0 >------------------- >This is a deprecation release for some health check related features. >The following are now deprecated: >* Passing :attr:`~hypothesis.HealthCheck.exception_in_generation` to > :attr:`~hypothesis.settings.suppress_health_check`. This no longer does > anything even when passed - All errors that occur during data generation > will now be immediately reraised rather than going through the health check > mechanism. >* Passing :attr:`~hypothesis.HealthCheck.random_module` to > :attr:`~hypothesis.settings.suppress_health_check`. This hasn't done anything > for a long time, but was never explicitly deprecated. Hypothesis always seeds > the random module when running given tests, so this is no longer an error > and suppressing it doesn't do anything. >* Passing non-:class:`~hypothesis.HealthCheck` values in > :attr:`~hypothesis.settings.suppress_health_check`. This was previously > allowed but never did anything useful. >In addition, passing a non-iterable value as :attr:`~hypothesis.settings.suppress_health_check` >will now raise an error immediately (it would never have worked correctly, but >it would previously have failed later). Some validation error messages have >also been updated. >This work was funded by `Smarkets <https://smarkets.com/>`_. >------------------- >### 3.36.1 >------------------- >This is a yak shaving release, mostly concerned with our own tests. >While :func:`~python:inspect.getfullargspec` was documented as deprecated >in Python 3.5, it never actually emitted a warning. Our code to silence >this (nonexistent) warning has therefore been removed. >We now run our tests with ``DeprecationWarning`` as an error, and made some >minor changes to our own tests as a result. This required similar upstream >updates to :pypi:`coverage` and :pypi:`execnet` (a test-time dependency via >:pypi:`pytest-xdist`). >There is no user-visible change in Hypothesis itself, but we encourage you >to consider enabling deprecations as errors in your own tests. >------------------- >### 3.36.0 >------------------- >This release adds a setting to the public API, and does some internal cleanup: >- The :attr:`~hypothesis.settings.derandomize` setting is now documented (:issue:`890`) >- Removed - and disallowed - all 'bare excepts' in Hypothesis (:issue:`953`) >- Documented the :attr:`~hypothesis.settings.strict` setting as deprecated, and > updated the build so our docs always match deprecations in the code. >------------------- >### 3.35.0 >------------------- >This minor release supports constraining :func:`~hypothesis.strategies.uuids` >to generate :class:`~python:uuid.UUID`s of a particular version. >(:issue:`721`) >Thanks to Dion Misic for this feature. >------------------- >### 3.34.1 >------------------- >This patch updates the documentation to suggest >:func:`builds(callable) <hypothesis.strategies.builds>` instead of >:func:`just(callable()) <hypothesis.strategies.just>`. >------------------- >### 3.34.0 >------------------- >Hypothesis now emits deprecation warnings if you apply >:func:`given <hypothesis.given>` more than once to a target. >Applying :func:`given <hypothesis.given>` repeatedly wraps the target multiple >times. Each wrapper will search the space of of possible parameters separately. >This is equivalent but will be much more inefficient than doing it with a >single call to :func:`given <hypothesis.given>`. >For example, instead of >``given(booleans()) given(integers())``, you could write >``given(booleans(), integers())`` >------------------- >### 3.33.1 >------------------- >This is a bugfix release: >- :func:`~hypothesis.strategies.builds` would try to infer a strategy for > required positional arguments of the target from type hints, even if they > had been given to :func:`~hypothesis.strategies.builds` as positional > arguments (:issue:`946`). Now it only infers missing required arguments. >- An internal introspection function wrongly reported ``self`` as a required > argument for bound methods, which might also have affected > :func:`~hypothesis.strategies.builds`. Now it knows better. >------------------- That's it for now! Happy merging! 🤖

161: Scheduled weekly dependency update for week 46 r=mithrandi ## Updates Here's a list of all the updates bundled in this pull request. I've added some links to make it easier for you to find all the information you need. <table align="center"> <tr> <td><b>attrs</b></td> <td align="center">17.2.0</td> <td align="center">»</td> <td align="center">17.3.0</td> <td> <a href="https://pypi.python.org/pypi/attrs">PyPI</a> | <a href="https://pyup.io/changelogs/attrs/">Changelog</a> | <a href="http://www.attrs.org/">Homepage</a> </td> <tr> <td><b>cryptography</b></td> <td align="center">2.1.2</td> <td align="center">»</td> <td align="center">2.1.3</td> <td> <a href="https://pypi.python.org/pypi/cryptography">PyPI</a> | <a href="https://pyup.io/changelogs/cryptography/">Changelog</a> | <a href="https:/pyca/cryptography">Repo</a> </td> <tr> <td><b>lxml</b></td> <td align="center">4.1.0</td> <td align="center">»</td> <td align="center">4.1.1</td> <td> <a href="https://pypi.python.org/pypi/lxml">PyPI</a> | <a href="https://pyup.io/changelogs/lxml/">Changelog</a> | <a href="http://lxml.de/">Homepage</a> | <a href="https://bugs.launchpad.net/lxml">Bugtracker</a> </td> <tr> <td><b>pytz</b></td> <td align="center">2017.2</td> <td align="center">»</td> <td align="center">2017.3</td> <td> <a href="https://pypi.python.org/pypi/pytz">PyPI</a> | <a href="http://pythonhosted.org/pytz">Homepage</a> | <a href="http://pythonhosted.org/pytz/">Docs</a> </td> </tr> </table> ## Changelogs ### attrs 17.2.0 -> 17.3.0 >### 17.3.0 >------------------- >Backward-incompatible Changes >^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ >- Attributes are not defined on the class body anymore. > This means that if you define a class ``C`` with an attribute ``x``, the class will *not* have an attribute ``x`` for introspection anymore. > Instead of ``C.x``, use ``attr.fields(C).x`` or look at ``C.__attrs_attrs__``. > The old behavior has been deprecated since version 16.1. > (`253 <https:/python-attrs/attrs/issues/253>`_) >Changes >^^^^^^^ >- ``super()`` and ``__class__`` now work on Python 3 when ``slots=True``. > (`102 <https:/python-attrs/attrs/issues/102>`_, `226 <https:/python-attrs/attrs/issues/226>`_, `269 <https:/python-attrs/attrs/issues/269>`_, `270 <https:/python-attrs/attrs/issues/270>`_, `272 <https:/python-attrs/attrs/issues/272>`_) >- Added ``type`` argument to ``attr.ib()`` and corresponding ``type`` attribute to ``attr.Attribute``. > This change paves the way for automatic type checking and serialization (though as of this release ``attrs`` does not make use of it). > In Python 3.6 or higher, the value of ``attr.Attribute.type`` can alternately be set using variable type annotations > (see `PEP 526 <https://www.python.org/dev/peps/pep-0526/>`_). (`151 <https:/python-attrs/attrs/issues/151>`_, `214 <https:/python-attrs/attrs/issues/214>`_, `215 <https:/python-attrs/attrs/issues/215>`_, `239 <https:/python-attrs/attrs/issues/239>`_) >- The combination of ``str=True`` and ``slots=True`` now works on Python 2. > (`198 <https:/python-attrs/attrs/issues/198>`_) >- ``attr.Factory`` is hashable again. (`204 > <https:/python-attrs/attrs/issues/204>`_) >- Subclasses now can overwrite attribute definitions of their superclass. > That means that you can -- for example -- change the default value for an attribute by redefining it. > (`221 <https:/python-attrs/attrs/issues/221>`_, `229 <https:/python-attrs/attrs/issues/229>`_) >- Added new option ``auto_attribs`` to ``attr.s`` that allows to collect annotated fields without setting them to ``attr.ib()``. > Setting a field to an ``attr.ib()`` is still possible to supply options like validators. > Setting it to any other value is treated like it was passed as ``attr.ib(default=value)`` -- passing an instance of ``attr.Factory`` also works as expected. > (`262 <https:/python-attrs/attrs/issues/262>`_, `277 <https:/python-attrs/attrs/issues/277>`_) >- Instances of classes created using ``attr.make_class()`` can now be pickled. > (`282 <https:/python-attrs/attrs/issues/282>`_) >---- ### lxml 4.1.0 -> 4.1.1 >### 4.1.1 >================== >* Rebuild with Cython 0.27.3 to improve support for Py3.7. That's it for now! Happy merging! 🤖

118: Update attrs to 17.3.0 r=mithrandi There's a new version of [attrs](https://pypi.python.org/pypi/attrs) available. You are currently using **17.2.0**. I have updated it to **17.3.0** These links might come in handy: <a href="https://pypi.python.org/pypi/attrs">PyPI</a> | <a href="https://pyup.io/changelogs/attrs/">Changelog</a> | <a href="http://www.attrs.org/">Homepage</a> ### Changelog > >### 17.3.0 >------------------- >Backward-incompatible Changes >^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ >- Attributes are not defined on the class body anymore. > This means that if you define a class ``C`` with an attribute ``x``, the class will *not* have an attribute ``x`` for introspection anymore. > Instead of ``C.x``, use ``attr.fields(C).x`` or look at ``C.__attrs_attrs__``. > The old behavior has been deprecated since version 16.1. > (`253 <https:/python-attrs/attrs/issues/253>`_) >Changes >^^^^^^^ >- ``super()`` and ``__class__`` now work on Python 3 when ``slots=True``. > (`102 <https:/python-attrs/attrs/issues/102>`_, `226 <https:/python-attrs/attrs/issues/226>`_, `269 <https:/python-attrs/attrs/issues/269>`_, `270 <https:/python-attrs/attrs/issues/270>`_, `272 <https:/python-attrs/attrs/issues/272>`_) >- Added ``type`` argument to ``attr.ib()`` and corresponding ``type`` attribute to ``attr.Attribute``. > This change paves the way for automatic type checking and serialization (though as of this release ``attrs`` does not make use of it). > In Python 3.6 or higher, the value of ``attr.Attribute.type`` can alternately be set using variable type annotations > (see `PEP 526 <https://www.python.org/dev/peps/pep-0526/>`_). (`151 <https:/python-attrs/attrs/issues/151>`_, `214 <https:/python-attrs/attrs/issues/214>`_, `215 <https:/python-attrs/attrs/issues/215>`_, `239 <https:/python-attrs/attrs/issues/239>`_) >- The combination of ``str=True`` and ``slots=True`` now works on Python 2. > (`198 <https:/python-attrs/attrs/issues/198>`_) >- ``attr.Factory`` is hashable again. (`204 > <https:/python-attrs/attrs/issues/204>`_) >- Subclasses now can overwrite attribute definitions of their superclass. > That means that you can -- for example -- change the default value for an attribute by redefining it. > (`221 <https:/python-attrs/attrs/issues/221>`_, `229 <https:/python-attrs/attrs/issues/229>`_) >- Added new option ``auto_attribs`` to ``attr.s`` that allows to collect annotated fields without setting them to ``attr.ib()``. > Setting a field to an ``attr.ib()`` is still possible to supply options like validators. > Setting it to any other value is treated like it was passed as ``attr.ib(default=value)`` -- passing an instance of ``attr.Factory`` also works as expected. > (`262 <https:/python-attrs/attrs/issues/262>`_, `277 <https:/python-attrs/attrs/issues/277>`_) >- Instances of classes created using ``attr.make_class()`` can now be pickled. > (`282 <https:/python-attrs/attrs/issues/282>`_) >---- *Got merge conflicts? Close this PR and delete the branch. I'll create a new PR for you.* Happy merging! 🤖

Add support for passing a type to attr.ib() and gathering the type fr…

69a7765

…om PEP526-style annotations.

chadrik mentioned this pull request Aug 28, 2017

Support Python 3.6 attribute annotations. #151

Closed

hynek requested changes Aug 30, 2017

View reviewed changes

hynek reviewed Aug 30, 2017

View reviewed changes

chadrik added 2 commits August 30, 2017 10:08

Address review notes.

d10e1af

More review notes.

143e89f

chadrik force-pushed the attr_type branch from e1a4f4c to 143e89f Compare August 30, 2017 17:08

hynek requested changes Aug 30, 2017

View reviewed changes

A few more review changes.

1c2f766

chadrik commented Aug 31, 2017

View reviewed changes

Tinche approved these changes Sep 3, 2017

View reviewed changes

src/attr/_make.py

.. versionchanged:: 17.1.0 *validator* can be a ``list`` now.

.. versionchanged:: 17.1.0

*hash* is ``None`` and therefore mirrors *cmp* by default .

.. versionadded:: 17.3.0 *type*

This comment was marked as spam.

Sign in to view

Quick final fix to the changelog.

0168ab8

Tinche merged commit 566ada9 into python-attrs:master Sep 17, 2017

This was referenced Sep 26, 2017

Typechecking attrs-generated classes python/mypy#2088

Closed

[RFC] First class type support #215

Closed

[RFC] PEP 526: class member annotations in 3.6 #214

Closed

anthrotype mentioned this pull request Nov 28, 2017

Support for automatic runtime type-checking #301

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Basic type support #239

Basic type support #239

chadrik commented Aug 28, 2017

codecov bot commented Aug 28, 2017 •

edited

Loading

hynek left a comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

chadrik commented Aug 30, 2017

hynek left a comment •

edited

Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

Tinche commented Aug 30, 2017

This comment was marked as spam.

This comment was marked as spam.

Tinche left a comment

This comment was marked as spam.

Tinche commented Sep 13, 2017

wsanchez commented Sep 13, 2017

Tinche commented Sep 17, 2017

Tinche commented Sep 17, 2017

chadrik commented Sep 17, 2017

		@@ -0,0 +1,3 @@
		Added ``type`` argument to ``attr.attr()`` and corresponding ``type`` attribute to ``attr.Attribute``.

		@@ -0,0 +1,3 @@
		Added ``type`` argument to ``attr.attr()`` and corresponding ``type`` attribute to ``attr.Attribute``.
		This value can be inspected by third-party tools for type checking and serialization.

Basic type support #239

Basic type support #239

Conversation

chadrik commented Aug 28, 2017

codecov bot commented Aug 28, 2017 • edited Loading

Codecov Report

hynek left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

chadrik commented Aug 30, 2017

hynek left a comment • edited Loading

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

Tinche commented Aug 30, 2017

This comment was marked as spam.

This comment was marked as spam.

Tinche left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

Tinche commented Sep 13, 2017

wsanchez commented Sep 13, 2017

Tinche commented Sep 17, 2017

Tinche commented Sep 17, 2017

chadrik commented Sep 17, 2017

codecov bot commented Aug 28, 2017 •

edited

Loading

hynek left a comment •

edited

Loading