Question 1

How do I use com2ann to convert type comments in a whole directory?

Accepted Answer

Specify the directory as the infile argument in the command line; com2ann will process all Python files recursively. Use -o for an output directory if you want to avoid in-place changes.

Question 2

com2ann vs pytype for adding type hints?

Accepted Answer

com2ann is specialized for converting existing type comments to annotations while preserving formatting, whereas pytype is a static type checker that can infer and add type hints but may reformat code and handle broader typing tasks.

Question 3

Can com2ann handle nested or complex type comments?

Accepted Answer

Yes, com2ann supports translating function and assignment type comments, including those in class methods, but it might miss edge cases with non-standard syntax due to its tokenizer-based approach.

Question 4

What Python versions does com2ann work with for target code?

Accepted Answer

com2ann can translate code for Python 3.4+ targets, which you can specify with --python-minor-version, but it requires Python 3.8 to run the tool itself.

Question 5

How to wrap long function signatures with com2ann?

Accepted Answer

Use the --wrap-signatures option with a maximum length (e.g., -w 80), and com2ann will wrap signatures one argument per line after commas for improved readability.

Question 6

Is com2ann compatible with black or other code formatters?

Accepted Answer

com2ann preserves original formatting, so it might not align with black's style. You should run black after com2ann if you want consistent formatting, as there's no direct integration.

Question 7

How to revert changes if com2ann makes an error?

Accepted Answer

There's no built-in revert feature; always use version control or backup files before running com2ann, and manually review changes with diff tools to correct any mistakes.

com2ann

What is com2ann?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions