cytomining / cytomining/CytoTable

Lint internal SQL as part of automated checks

Open
#107 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
21
Forks
6
Avg merge
2d 3h
Merged PRs (30d)
6

Description

This issue highlights a need to lint SQL as part of automated checks performed with code changes. Doing this might help prevent issues like #105 from coming up and make maintenance less error-prone.

One approach might be to use [typing `NewType`](https://docs.python.org/3/library/typing.html#newtype)'s to help capture and signify how SQL strings might differ from other strings.

For example:
```python
from typing import NewType

# Define a custom type hint for SQL strings
SQLString = NewType('SQLString', str)
```

From here, these strings could be gathered and linted from within the Python modules where they might be found.

Generally, this might be at odds with #77, where the use of these strings may diminish in future development.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.