Skip to content

docs: docstrings for schema version classes #946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkowalleck merged 1 commit into from
Mar 13, 2026
+10 −10
Merged

docs: docstrings for schema version classes #946

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions cyclonedx/schema/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
from . import SchemaVersion


class BaseSchemaVersion(ABC, ViewType):

class BaseSchemaVersion(ViewType, ABC):
"""Base class for schema version views."""
@property
@abstractmethod
def schema_version_enum(self) -> SchemaVersion:
Expand All @@ -35,56 +35,56 @@ def get_schema_version(self) -> str:


class SchemaVersion1Dot7(BaseSchemaVersion):

"""Schema version views 1.7"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_7]:
return SchemaVersion.V1_7


class SchemaVersion1Dot6(BaseSchemaVersion):

"""Schema version views 1.6"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_6]:
return SchemaVersion.V1_6


class SchemaVersion1Dot5(BaseSchemaVersion):

"""Schema version views 1.5"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_5]:
return SchemaVersion.V1_5


class SchemaVersion1Dot4(BaseSchemaVersion):

"""Schema version views 1.4"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_4]:
return SchemaVersion.V1_4


class SchemaVersion1Dot3(BaseSchemaVersion):

"""Schema version views 1.3"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_3]:
return SchemaVersion.V1_3


class SchemaVersion1Dot2(BaseSchemaVersion):

"""Schema version views 1.2"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_2]:
return SchemaVersion.V1_2


class SchemaVersion1Dot1(BaseSchemaVersion):

"""Schema version views 1.1"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_1]:
return SchemaVersion.V1_1


class SchemaVersion1Dot0(BaseSchemaVersion):

"""Schema version views 1.0"""
@property
def schema_version_enum(self) -> Literal[SchemaVersion.V1_0]:
return SchemaVersion.V1_0
Expand Down
Loading