Skip to content

Commit ebd9319

Browse files
authored
1043 enforce default formatting (#1060)
* feat: adding flake8 extension that checks for default= and ... Still needs work, this catches situations that it shouldn't catch * chore: missing default= * chore: realized there is a special linters section
1 parent f10b06b commit ebd9319

File tree

7 files changed

+15
-10
lines changed

7 files changed

+15
-10
lines changed

.flake8

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@ exclude =
55
build
66
max-complexity = 10
77
max-line-length = 120
8+
9+
[flake8:local-plugins]
10+
extension =
11+
PF = aind_flake8_extensions.plugin:run_ast_checks

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ linters = [
3333
'coverage',
3434
'flake8',
3535
'interrogate',
36-
'isort'
36+
'isort',
37+
'aind-flake8-extensions'
3738
]
3839

3940
docs = [

src/aind_data_schema/components/devices.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ class Laser(Device):
528528
power_unit: PowerUnit = Field(default=PowerUnit.MW, title="Power unit")
529529
coupling: Optional[Coupling] = Field(default=None, title="Coupling")
530530
coupling_efficiency: Optional[Decimal] = Field(
531-
None,
531+
default=None,
532532
title="Coupling efficiency (percent)",
533533
ge=0,
534534
le=100,

src/aind_data_schema/components/stimulus.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class OptoStimulation(AindModel):
4040
pulse_train_duration_unit: TimeUnit = Field(default=TimeUnit.S, title="Pulse train duration unit")
4141
fixed_pulse_train_interval: bool = Field(..., title="Fixed pulse train interval")
4242
pulse_train_interval: Optional[Decimal] = Field(
43-
None, title="Pulse train interval (s)", description="Time between pulse trains"
43+
default=None, title="Pulse train interval (s)", description="Time between pulse trains"
4444
)
4545
pulse_train_interval_unit: TimeUnit = Field(default=TimeUnit.S, title="Pulse train interval unit")
4646
baseline_duration: Decimal = Field(

src/aind_data_schema/core/instrument.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class Instrument(AindCoreModel):
3838
schema_version: Literal["1.0.0"] = Field("1.0.0")
3939

4040
instrument_id: Optional[str] = Field(
41-
None,
41+
default=None,
4242
description="Unique instrument identifier, name convention: <room>-<apparatus name>-<date modified YYYYMMDD>",
4343
title="Instrument ID",
4444
)
@@ -58,12 +58,12 @@ class Instrument(AindCoreModel):
5858
scanning_stages: List[ScanningStage] = Field(default=[], title="Scanning motorized stages")
5959
additional_devices: List[AdditionalImagingDevice] = Field(default=[], title="Additional devices")
6060
calibration_date: Optional[date] = Field(
61-
None,
61+
default=None,
6262
description="Date of most recent calibration",
6363
title="Calibration date",
6464
)
6565
calibration_data: Optional[str] = Field(
66-
None,
66+
default=None,
6767
description="Path to calibration data from most recent calibration",
6868
title="Calibration data",
6969
)

src/aind_data_schema/core/procedures.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ class SpecimenProcedure(AindModel):
241241

242242
procedure_type: SpecimenProcedureType = Field(..., title="Procedure type")
243243
procedure_name: Optional[str] = Field(
244-
None, title="Procedure name", description="Name to clarify specific procedure used as needed"
244+
default=None, title="Procedure name", description="Name to clarify specific procedure used as needed"
245245
)
246246
specimen_id: str = Field(..., title="Specimen ID")
247247
start_date: date = Field(..., title="Start date")

src/aind_data_schema/core/subject.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ class Subject(AindCoreModel):
9898
sex: Sex = Field(..., title="Sex")
9999
date_of_birth: date_type = Field(..., title="Date of birth")
100100
genotype: Optional[str] = Field(
101-
None,
101+
default=None,
102102
description="Genotype of the animal providing both alleles",
103103
title="Genotype",
104104
)
@@ -112,12 +112,12 @@ class Subject(AindCoreModel):
112112
title="Source",
113113
)
114114
rrid: Optional[PIDName] = Field(
115-
None,
115+
default=None,
116116
description="RRID of mouse if acquired from supplier",
117117
title="RRID",
118118
)
119119
restrictions: Optional[str] = Field(
120-
None,
120+
default=None,
121121
description="Any restrictions on use or publishing based on subject source",
122122
title="Restrictions",
123123
)

0 commit comments

Comments
 (0)