Bug#976241: marked as done (ITP: pyannotate -- PyAnnotate: Auto-generate PEP-484 annotations)
Your message dated Sun, 06 Dec 2020 13:00:17 +0000
with message-id <E1klteD-0005nA-9f@fasolo.debian.org>
and subject line Bug#976241: fixed in pyannotate 1.2.0-1
has caused the Debian Bug report #976241,
regarding ITP: pyannotate -- PyAnnotate: Auto-generate PEP-484 annotations
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)
--
976241: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=976241
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message ---
Package: wnpp
Severity: wishlist
Owner: Sandro Tosi <morph@debian.org>
* Package name : pyannotate
Version : 1.2.0
Upstream Author : Dropbox <guido@dropbox.com>
* URL : https://github.com/dropbox/pyannotate
* License : Apache 2.0
Programming Lang: Python
Description : PyAnnotate: Auto-generate PEP-484 annotations
Binary package names: python3-pyannotate
PyAnnotate: Auto-generate PEP-484 annotations
=============================================
.
Insert annotations into your source code based on call arguments and
return types observed at runtime.
.
For license and copyright see the end of this file.
.
Blog post: http://mypy-lang.blogspot.com/2017/11/dropbox-releases-pyannotate-auto.html
.
How to use
==========
.
See also the example directory.
.
Phase 1: Collecting types at runtime
------------------------------------
.
- Install the usual way (see "red tape" section below)
- Add `from pyannotate_runtime import collect_types` to your test
- Early in your test setup, call `collect_types.init_types_collection()`
- Bracket your test execution between calls to `collect_types.start()` and
`collect_types.stop()` (or use the context manager below)
- When done, call `collect_types.dump_stats(filename)`
.
All calls between the `start()` and `stop()` calls will be analyzed
and the observed types will be written (in JSON form) to the filename
you pass to `dump_stats()`. You can have multiple start/stop pairs
per dump call.
.
If you'd like to automatically collect types when you run `pytest`,
see `example/example_conftest.py` and `example/README.md`.
.
Instead of using `start()` and `stop()` you can also use a context
manager:
```
collect_types.init_types_collection()
with collect_types.collect():
<your code here>
collect_types.dump_stats(<filename>)
```
.
Phase 2: Inserting types into your source code
----------------------------------------------
.
The command-line tool `pyannotate` can add annotations into your
source code based on the annotations collected in phase 1. The key
arguments are:
.
- Use `--type-info FILE` to tell it the file you passed to `dump_stats()`
- Positional arguments are source files you want to annotate
- With no other flags the tool will print a diff indicating what it
proposes to do but won't do anything. Review the output.
- Add `-w` to make the tool actually update your files.
(Use git or some other way to keep a backup.)
.
At this point you should probably run mypy and iterate. You probably
will have to tweak the changes to make mypy completely happy.
.
Notes and tips
--------------
.
- It's best to do one file at a time, at least until you're
comfortable with the tool.
- The tool doesn't touch functions that already have an annotation.
- The tool can generate either of:
- type comments, i.e. Python 2 style annotations
- inline type annotations, i.e. Python 3 style annotations, using `--py3` in v1.0.7+
.
Red tape
========
.
--- End Message ---
--- Begin Message ---
Source: pyannotate
Source-Version: 1.2.0-1
Done: Sandro Tosi <morph@debian.org>
We believe that the bug you reported is fixed in the latest version of
pyannotate, which is due to be installed in the Debian FTP archive.
A summary of the changes between this version and the previous one is
attached.
Thank you for reporting the bug, which will now be closed. If you
have further comments please address them to 976241@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Sandro Tosi <morph@debian.org> (supplier of updated pyannotate package)
(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256
Format: 1.8
Date: Wed, 02 Dec 2020 02:38:45 +0000
Source: pyannotate
Binary: python3-pyannotate
Architecture: source all
Version: 1.2.0-1
Distribution: unstable
Urgency: low
Maintainer: Sandro Tosi <morph@debian.org>
Changed-By: Sandro Tosi <morph@debian.org>
Description:
python3-pyannotate - auto-generate PEP-484 annotations
Closes: 976241
Changes:
pyannotate (1.2.0-1) unstable; urgency=low
.
* Initial release; Closes: #976241
Checksums-Sha1:
f92307d58e13c9a56e6c548ae42f60ae134c9457 2082 pyannotate_1.2.0-1.dsc
a107bf2a5184b43879dad20f7e217238317c1582 46148 pyannotate_1.2.0.orig.tar.gz
8b471250db460871926975004d89538fcc9530ce 1484 pyannotate_1.2.0-1.debian.tar.xz
0fe32eb00784c4c26765f9d219929cf78d1d5039 8263 pyannotate_1.2.0-1_amd64.buildinfo
7d202928edf4e941cbaa1fa6cc929115763d2760 27784 python3-pyannotate_1.2.0-1_all.deb
Checksums-Sha256:
9776a8ce1f825b05b75f74698d0c1dbe58ca68a66d550d2de37f4b8b4641e803 2082 pyannotate_1.2.0-1.dsc
c5b0256b2e77213725de7c146e1f78576a04215276b68078a97915a677bbdef7 46148 pyannotate_1.2.0.orig.tar.gz
d6ad9edd466e457bc26319f4b640db76505c43ab6a9c0aaad92a8a3d6635626b 1484 pyannotate_1.2.0-1.debian.tar.xz
becdc4684e506db5bccc5e70b0c5efc1bdddef4c01867bb2f258165922dc2e5d 8263 pyannotate_1.2.0-1_amd64.buildinfo
0e4490eddb4b39fcbde69caeb5140019511b742352a0a7437f5f8319ddf618f3 27784 python3-pyannotate_1.2.0-1_all.deb
Files:
fc9fd982c8c4a803a372aa8e248d44f8 2082 python optional pyannotate_1.2.0-1.dsc
f59df864a7ad5d15a5d1281ec6a383df 46148 python optional pyannotate_1.2.0.orig.tar.gz
1f21166525a8d49d391aabff33a2334b 1484 python optional pyannotate_1.2.0-1.debian.tar.xz
71b016065c30677edbb851633dc2e632 8263 python optional pyannotate_1.2.0-1_amd64.buildinfo
a1b6ff599fa6ca628ae022e601796118 27784 python optional python3-pyannotate_1.2.0-1_all.deb
-----BEGIN PGP SIGNATURE-----
iQIzBAEBCAAdFiEEufrTGSrz5KUwnZ05h588mTgBqU8FAl/HDEsACgkQh588mTgB
qU/roA//UXWs0sjk8mrWmlsLyO2vBZWZHcjr6jzj8OE2uKqlYJkyFDnijpeqGgAP
zgOD72At3yEPPIaTvb1TSJqo3Kjl6vtrwjShHrBUtpsCGPD2BNNAOzPrkGYOEPCl
98IGmZ1Re+TU4v+mgcVSYvhWPL+2qx50Eis0uGUEerdy8etT0ZvZyMKIAFSJ+V3N
tsUu0AQryZKPYzx5Fr9wbuhVyg0+yzfbAuGrcZwcekhzK07VJTMpdNeJktkk/SBF
RSDwXsp7lAoWe6umeRW/GoQbkV+Qw0j6U2TRAKRFf28COE4PVCVnE4gFcAD/63Wg
rgt4cS268IlKi3oo2Y9hwpC5eBlTvNqWSvhn3JA2fRqk76KgFt8q3WgHwss18JAH
4X+ZDWHYCNEsdrLC2LgPwefjxXxaVLXgSdwGP1f222tvKMUluFL51cNHb3BB6RQR
x4TNjIWwi4vvx4f52rgf4JY9QBkp5l6T/qamRMnVsX8Ci5N7GfUzOM0sn0dnlPZv
dzQks4lPC96nTr29gyfK3jRv4DTl5A2gQ9b+QtSOD2DxMh5oiKRHIlLzrt4ytvnn
60UYRV5YCiBIN0yvbRmfuBW4yml0o8WoewphSKzbgRjBnnTQ1071GU+EAU3mQc/m
L3jVWFzSCuJdeGbaswdflXHTaxLrdG8gH1ajvHLfxVQGeMhGYIw=
=VIjZ
-----END PGP SIGNATURE-----
--- End Message ---
Reply to: