Skip to content

Deprecate wrapper constants for .proto enumsΒ #551

@ansjmoody

Description

@ansjmoody

πŸ“ Description of the feature

Deprecate constants that are wrappers of enums that are defined in the .proto files. It is preferable to use the enums as defined in the .proto files and document this usage using type hints.

An example for this can be seen in parts_types.py, PartsListSearchMatchingMode.
The classes to remove are listed here.
analysis_types.py

  • ElementOrder
  • ModelSource
  • RunAnalysisRequestAnalysisType
  • RunStrainMapAnalysisRequestAnalysisType
  • UpdatePcbModelingPropsRequestAnalysisType
  • UpdatePcbModelingPropsRequestPcbMaterialModel
  • UpdatePcbModelingPropsRequestPcbModelType

parts_types.py

  • PartsListSearchDuplicationMode
  • AVLPartNum
  • AVLDescription

Update the following to reference the enums defined in the .proto files:

  • Type hints
  • API usage examples
  • examples

It will help to include a version that this is decremented in.
E.g. 25.2
Since this isn't specified in PartsListSearchMatchingMode, it is fine to set the version to 25.2 for that. This way all of these can be removed at the same time.

πŸ’‘ Steps for implementing the feature

No response

πŸ”— Useful links and references

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew features or code improvementsmaintenancePackage and maintenance related

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions