tach-ignore¶
To ignore a particular import which should be allowed unconditionally, use the tach-ignore
comment directive.
# tach-ignore
from core.main import private_function
from core.api import private_calculation # tach-ignore
from core.package import ( # tach-ignore
service_one,
service_two
)
The directive can also be specific about the import to ignore, which is particularly useful when importing multiple packages.
# tach-ignore private_function
from core.main import private_function, public_function
from core.api import private_calculation, public_service # tach-ignore private_calculation
from core.package import ( # tach-ignore service_two
service_one,
service_two
)
Note: Names given to tach-ignore
should match the alias as it is used in the subsequent import line, not the full module path from the project root.
Reasons¶
Tach also allows you to add a message next to the ignore directive, to document the reasoning for the ignore.