You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current "immutable" and "cached" annotations are used to indicate database columns that are read-only and holding disposable values, respectively.
We need one or two more annotations:
"temporary": indicating that this column was added as a quick hack. Any further use of the column should be based on a refactoring for permanent status.
"deprecated": indicating that this column is marked for removal and so should not be used in new code. However, the utility of this annotation is unclear as there is no indication of what replaces it.
Further, these annotations (except "immutable") have no practical value over regular Python comments placed alongside the column. This is an open problem. Possibilities:
The annotation inserts itself into the docstring so that it is visible in code intelligence in an editor. However, docstrings are typically on classes, but columns are instances.
The annotation causes a Python warning to be raised whenever it is applied on a column, causing a list of such warnings to be displayed every time the app is run in developer mode. However, this will get pretty annoying as "temporary" annotations are temporary on the basis of attention to a feature, not time in use.
The text was updated successfully, but these errors were encountered:
The current "immutable" and "cached" annotations are used to indicate database columns that are read-only and holding disposable values, respectively.
We need one or two more annotations:
"temporary": indicating that this column was added as a quick hack. Any further use of the column should be based on a refactoring for permanent status.
"deprecated": indicating that this column is marked for removal and so should not be used in new code. However, the utility of this annotation is unclear as there is no indication of what replaces it.
Further, these annotations (except "immutable") have no practical value over regular Python comments placed alongside the column. This is an open problem. Possibilities:
The annotation inserts itself into the docstring so that it is visible in code intelligence in an editor. However, docstrings are typically on classes, but columns are instances.
The annotation causes a Python warning to be raised whenever it is applied on a column, causing a list of such warnings to be displayed every time the app is run in developer mode. However, this will get pretty annoying as "temporary" annotations are temporary on the basis of attention to a feature, not time in use.
The text was updated successfully, but these errors were encountered: