Stronger types and more hierarchical directory structures for upcoming sub-packages - Githubissues

broadinstitute / cromwell-tools

A collection of Python clients and accessory scripts for interacting with the Cromwell

https://cromwell-tools.readthedocs.io

BSD 3-Clause "New" or "Revised" License

22 stars 9 forks source link

Stronger types and more hierarchical directory structures for upcoming sub-packages #86

Closed rexwangcc closed 5 years ago

rexwangcc commented 5 years ago

Purpose

Use type annotations so it's much easier for IDEs and static tools to analyze and infer the code.
Make the docstrings cleaner.
Create placeholder directories for the next PR to better organize the code without breaking the existing downstream consumers. This also helps with adding upcoming sub-packages to the tool.

Changes

Replace typing hints in the docstrings with recommended type annotations from the typing module. There should be NO functional changes.
Extract exceptions into a standalone module. There should be NO functional changes.
Create some placeholder directories.

Review Instructions

THANKS FOR YOUR TIME :)