feat: Adds ThemeConfig (TypedDict)
#3536
Commits on Aug 12, 2024
-
-
-
perf: Use more appropriate data structures in
codegenMostly avoiding use `list` unless properties of it are needed. Also using `set` comprehensions
-
refactor: Reduce length and complexity of `get_python_type_representa…
…tion` Provides all existing functionality. Adds `use_concrete`, for upcoming `TypedDict` changes
-
refactor(perf): Rewrite
generate_vegalite_mark_mixin- Adapted to new `get_python_type_representation` - Avoid nested listcomp - Avoid repeated sorting - Moved the generic parts to `_generate_sig_args`
-
-
-
-
refactor: Rename
get_python_type_representation->to_type_reprWill be adding a docstring with more detail
-
refactor: Remove redundant
is_objectbranchHandled by `jsonschema_to_python_types`
-
-
-
-
-
-
Commits on Aug 13, 2024
-
refactor: Replace
is_value()case incodegen.get_args()Was the only place `SchemaInfo.is_value` had been called. Planning to use that method to identify schemas with **only** 1 property, which is named *value*. This will be much more useful, in allowing generic `TypedDict`(s) like https://github.com/vega/altair/blob/b996fa45d66c94266b97475eab0723b1841436cf/altair/vegalite/v5/api.py#L644
-
-
-
Commits on Aug 14, 2024
-
feat: Adds
SchemaInfo.is_type_aliasSee doc for examples vega#3536 (comment)
-
build: run
generate-schema-wrapperExcludes `FontStyle`, `SymbolShape` aliases for `str` vega#3536 (comment), vega#3536 (comment)
-
feat: Adds
utils.import_typing_extensionsStandardising version-gated `typing` imports
-
-
-
-
It is supposed to describe the top-level config
-
-
feat(typing): Adds
OverlayMarkDefKwdsSufficiently complex to require a `TypedDict` vega#3536 (comment)
-
-
-
-
-
-
feat: Use a dynamic
ClassVarfor remapping titlesPreviously required maintaining two sets of definitions
-
Commits on Aug 15, 2024
-
fix: Include
ArgInfo.requiredinTypedDict(s)Had not been needed so far, but `...GradientKwds` was missing `gradient`, `stops`
-
-
ci: Remove old dependency
m2rfrommypyNot needed since vega#3506
-
-
-
feat(typing): Temporarily duplicate (vega#3538)
Still need the changes here prior to that merging. It solves issues in `_config.py` as well. vega#3538
-
Merge pull request #1 from vega/remove-m2r-mypy
ci: Remove old dependency `m2r` from `mypy`
-
fix: Exclude titles w/
SchemaInfo.additionalPropertiesAvoids the `DateTime` properties `Day`, `Month`
-
feat: Fill out
MANUAL_DEFSwith all remaining targetsWill serve as a baseline for any replacement solution (provided the schema does not change first).
-
-
-
-
-
feat(typing): Finish
ThemeConfighierarchyA user should now be able to specify a theme, with full type-checking - without needing to import any of the lower-level objects.
Commits on Aug 16, 2024
-
-
-
-
refactor: Tidy up
generate_schema_wrapper.py- Adds and reuses `load_schema` - Factor out `_add_shorthand_property_to_field_encodings` - perf: Share non-modified shorthand dict in `load_schema_with_shorthand_properties` - Improve annotations - Remove some blank lines
Commits on Aug 17, 2024
-
perf: Reprioritise unreachable
info.allOfAppears to be some that used to be in the schema, but now is not. I've kept around with an error raised if it gets triggered in the future.
-
-
refactor(typing): Remove some
Nonecases forSchemaInfoUsing an empty string is consistent with `dict`, `list` properties.
Commits on Aug 27, 2024
Commits on Sep 1, 2024
Commits on Sep 3, 2024
-
Merge branch 'config-typed-dict' of https://github.com/dangotbanned/a…
…ltair into config-typed-dict
-
-
Commits on Sep 5, 2024
Commits on Sep 6, 2024
Commits on Sep 7, 2024
-
-
-
feat(typing): Enable type checking on
tools/Also fixes some warnings only present for `mypy`, but not `pyright`.
-
-
refactor: Make
SchemaInfoeffectively immutableThis was the only instance where a modification occured after init. The result of this is identical, simply moves the overwrite to the `dict` constructor. vega#3536 (comment)
-
Commits on Sep 8, 2024
-
perf: Use cheaper comparison for
SchemaInfo.__eq__Slightly faster (1.3s -> 1.2s) during deep recursion. Also a lot easier to understand vega#3536 (comment)
-
-
build: run
generate-schema-wrapper**Important**: The diff here is due to the introduction of sorting only. vega#3536 (comment), vega#3536 (comment)
-
Commits on Sep 9, 2024
-
refactor: Un-special-case
Dict, include inSchemaInfo.is_type_aliasThe schema here is unique and aligns (conceptually) with the excluded types that fell under this rule
-
-
Merge branch 'config-typed-dict' of https://github.com/dangotbanned/a…
…ltair into config-typed-dict
-
-
refactor: Simplify
generate_config_typed_dicts- All of this logic is now handled elsewhere. - Updated some names to be more consistent
-
docs: Link to discussion for unresolvable issue
Closing threads on this, leaving comments for future reference. Cannot see a solution for this
-
-
feat(typing): Accept an
Iteratorinindent_docstringSimply collects the lines if needed
-
-
-
-
-
test(typing): Adds
test_theme_config_typingPushing with errors for discussion
Commits on Sep 10, 2024
-
test: Remove
Vega-only properties from theme tests"group", "path", "shape", "symbol" all appear in a `vega-themes` definition. Haven't found any documentation on this, for `vega-lite`. All of these properties are not mentioned in the `Config` schema
-
-
fix: Remove
Vega-only properties from vendoredvega-themes.jsonThe fix here should allow these properties in the future - were they to become available in `Config` https://github.com/vega/altair/actions/runs/10789757058/job/29923430898?pr=3536
-
fix: Support hyphenated keys in
TypedDict(s)This support does not extend to `mypy`, so I've mentioned that in the doc. See https://peps.python.org/pep-0728/#reference-implementation https://github.com/vega/altair/actions/runs/10789757058/job/29923430898?pr=3536
-
Commits on Sep 11, 2024
-
-
-
-
refactor: Reuse
finalize_type_reprs- Extracted final steps of ``SchemaInfo.to_type_repr``. - Improved docs
-
chore: Rename
init_subclass_args->metaclass_kwdsThe latter is more accurate, there is no `__init__subclass__` involved - despite the similar syntax
-
-
refactor: Move
process_descriptiontotools.schemapi.utilsSuspect this might have been used more dynamically in the past. Currently doesn't make sense defining across 3 files
-
-
refactor: Include
process_descriptionindeep_descriptionEvery usage of the property is wrapped in the call. No longer need to import in `generate_schema_wrapper.py`
-
perf: Replace relative links on entire description
Previously was len(description.split()) times
-
refactor(perf): Compile patterns and tidy up
fix_docstring_issuesStill don't fully understand why this is written so verbosely
-
-
-
refactor: Remove unused
ruff_format_strWas replaced with `ruff_write_lint_format_str` in 485eae5
Commits on Sep 12, 2024
-
refactor: Factor out
_signature_args, enhanceArgInfo.iter_args- Moved constant parts of mark methods to the template
-
refactor: Add
SchemaInfo.from_refnameconstructorReplaces all instances that use this pattern
-
-
-
-
-
refactor: Accept multiple remap titles
Partial fix for vega#3536 (comment)
-
Commits on Sep 13, 2024
-
feat(typing): Adds missing types for
TopLevelUnitSpecResolves most of vega#3536 (comment)
-
-
-
-
-
-
-
fix(typing): Use a single
TypeVarforRowColIf both properties are specified, they must always be of the same type.
-
-
-
fix(typing): Satisfy
mypyonutils.core.update_nestedThis is due to a `TypedDict` being typed as `Mapping` instead of `MutableMapping` (like `dict`). At runtime it is a `dict`, so I'm not making any runtime changes - this will have to do
-
-
-
-
-
-
-
Commits on Sep 16, 2024
-
-
Update altair/vegalite/v5/schema/_typing.py
Co-authored-by: Stefan Binder <[email protected]>
-
-
-
refactor: Reuse literals, add
_typingdicts to_config.__all__Trying to make this easier to maintain in the future vega#3536 (comment)
-
-
docs: Use
:class:directive onTypedDict(s)Hopefully this will mean we can skip adding individual doc pages for each, just reuse the existing ones vega#3536 (comment)
-
fix: Define
typingas a package to support submodulesThe usage I described in the description was not actually possible: >- The top-level object `ThemeConfig` is exported to `altair.typing`> - All others are accessible via `altair.typing.theme`. This resolves the `ModuleNotFoundError` that would get raised when trying this
