Skip to content
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.

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

chore: making all use of Field(default=None) consistent for Optional … #1041

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/aind_data_schema/components/coordinates.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,4 @@ class RelativePosition(AindModel):
..., title="Device origin", description="Reference point on device for position information"
)
device_axes: List[Axis] = Field(..., title="Device axes", min_length=3, max_length=3)
notes: Optional[str] = Field(None, title="Notes")
notes: Optional[str] = Field(default=None, title="Notes")
4 changes: 2 additions & 2 deletions src/aind_data_schema/components/tile.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ class AcquisitionTile(Tile):
notes: Optional[str] = Field(default=None, title="Notes")
imaging_angle: int = Field(default=0, title="Imaging angle")
imaging_angle_unit: AngleUnit = Field(default=AngleUnit.DEG, title="Imaging angle unit")
acquisition_start_time: Optional[AwareDatetimeWithDefault] = Field(None, title="Acquisition start time")
acquisition_end_time: Optional[AwareDatetimeWithDefault] = Field(None, title="Acquisition end time")
acquisition_start_time: Optional[AwareDatetimeWithDefault] = Field(default=None, title="Acquisition start time")
acquisition_end_time: Optional[AwareDatetimeWithDefault] = Field(default=None, title="Acquisition end time")
4 changes: 3 additions & 1 deletion src/aind_data_schema/core/data_description.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,9 @@ class DataDescription(AindCoreModel):
title="Related data",
description="Path and description of data assets associated with this asset (eg. reference images)",
)
data_summary: Optional[str] = Field(None, title="Data summary", description="Semantic summary of experimental goal")
data_summary: Optional[str] = Field(
default=None, title="Data summary", description="Semantic summary of experimental goal"
)

@classmethod
def parse_name(cls, name):
Expand Down
8 changes: 4 additions & 4 deletions src/aind_data_schema/core/instrument.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ class Instrument(AindCoreModel):
modification_date: date = Field(..., title="Date of modification")
instrument_type: ImagingInstrumentType = Field(..., title="Instrument type")
manufacturer: Organization.ONE_OF = Field(..., title="Instrument manufacturer")
temperature_control: Optional[bool] = Field(None, title="Temperature control")
humidity_control: Optional[bool] = Field(None, title="Humidity control")
temperature_control: Optional[bool] = Field(default=None, title="Temperature control")
humidity_control: Optional[bool] = Field(default=None, title="Humidity control")
optical_tables: List[OpticalTable] = Field(default=[], title="Optical table")
enclosure: Optional[Enclosure] = Field(None, title="Enclosure")
enclosure: Optional[Enclosure] = Field(default=None, title="Enclosure")
objectives: List[Objective] = Field(..., title="Objectives")
detectors: List[Detector] = Field(default=[], title="Detectors")
light_sources: List[LIGHT_SOURCES] = Field(default=[], title="Light sources")
Expand All @@ -69,7 +69,7 @@ class Instrument(AindCoreModel):
)
com_ports: List[Com] = Field(default=[], title="COM ports")
daqs: List[DAQDevice] = Field(default=[], title="DAQ")
notes: Optional[str] = Field(None, validate_default=True)
notes: Optional[str] = Field(default=None, validate_default=True)

@field_validator("daqs", mode="after")
def validate_device_names(cls, value: List[DAQDevice], info: ValidationInfo) -> List[DAQDevice]:
Expand Down
10 changes: 6 additions & 4 deletions src/aind_data_schema/core/metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,12 @@ class Metadata(AindCoreModel):
procedures: Optional[Procedures] = Field(
default=None, title="Procedures", description="All procedures performed on a subject."
)
session: Optional[Session] = Field(None, title="Session", description="Description of a session.")
rig: Optional[Rig] = Field(None, title="Rig", description="Rig.")
processing: Optional[Processing] = Field(None, title="Processing", description="All processes run on data.")
acquisition: Optional[Acquisition] = Field(None, title="Acquisition", description="Imaging acquisition session")
session: Optional[Session] = Field(default=None, title="Session", description="Description of a session.")
rig: Optional[Rig] = Field(default=None, title="Rig", description="Rig.")
processing: Optional[Processing] = Field(default=None, title="Processing", description="All processes run on data.")
acquisition: Optional[Acquisition] = Field(
default=None, title="Acquisition", description="Imaging acquisition session"
)
instrument: Optional[Instrument] = Field(
default=None, title="Instrument", description="Instrument, which is a collection of devices"
)
Expand Down
4 changes: 1 addition & 3 deletions src/aind_data_schema/core/procedures.py
Original file line number Diff line number Diff line change
Expand Up @@ -568,9 +568,7 @@ class MyomatrixContact(AindModel):
class MyomatrixThread(AindModel):
"""Description of a thread of a myomatrix array"""

ground_electrode_location: MouseAnatomicalStructure.BODY_PARTS = Field(
..., title="Location of ground electrode"
)
ground_electrode_location: MouseAnatomicalStructure.BODY_PARTS = Field(..., title="Location of ground electrode")
contacts: List[MyomatrixContact] = Field(..., title="Contacts")


Expand Down
14 changes: 7 additions & 7 deletions src/aind_data_schema/core/subject.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ class WellnessReport(AindModel):
class Housing(AindModel):
"""Description of subject housing"""

cage_id: Optional[str] = Field(None, title="Cage ID")
room_id: Optional[str] = Field(None, title="Room ID")
light_cycle: Optional[LightCycle] = Field(None, title="Light cycle")
cage_id: Optional[str] = Field(default=None, title="Cage ID")
room_id: Optional[str] = Field(default=None, title="Room ID")
light_cycle: Optional[LightCycle] = Field(default=None, title="Light cycle")
home_cage_enrichment: List[HomeCageEnrichment] = Field(default=[], title="Home cage enrichment")
cohoused_subjects: List[str] = Field(
default=[],
Expand Down Expand Up @@ -104,8 +104,8 @@ class Subject(AindCoreModel):
)
species: Species.ONE_OF = Field(..., title="Species")
alleles: List[PIDName] = Field(default=[], title="Alleles", description="Allele names and persistent IDs")
background_strain: Optional[BackgroundStrain] = Field(None, title="Background strain")
breeding_info: Optional[BreedingInfo] = Field(None, title="Breeding Info")
background_strain: Optional[BackgroundStrain] = Field(default=None, title="Background strain")
breeding_info: Optional[BreedingInfo] = Field(default=None, title="Breeding Info")
source: Organization.SUBJECT_SOURCES = Field(
...,
description="Where the subject was acquired from. If bred in-house, use Allen Institute.",
Expand All @@ -122,8 +122,8 @@ class Subject(AindCoreModel):
title="Restrictions",
)
wellness_reports: List[WellnessReport] = Field(default=[], title="Wellness Report")
housing: Optional[Housing] = Field(None, title="Housing")
notes: Optional[str] = Field(None, title="Notes")
housing: Optional[Housing] = Field(default=None, title="Housing")
notes: Optional[str] = Field(default=None, title="Notes")

@field_validator("source", mode="after")
def validate_inhouse_breeding_info(cls, v: Organization.ONE_OF, info: ValidationInfo):
Expand Down
Loading