Skip to content
Machinewright

Contracts

Typed quantities, interfaces, and compatibility checks.

ConnectorInterface

Section titled “ConnectorInterface”

class in machinewright.contracts

class ConnectorInterface(InterfaceBase)

No description yet.

DistributorSkuIdentity

Section titled “DistributorSkuIdentity”

class in machinewright.contracts

class DistributorSkuIdentity(Contract)

No description yet.

DutyCycleRating

Section titled “DutyCycleRating”

class in machinewright.contracts

class DutyCycleRating(Contract)

Generic duty capability used for compatibility screening.

Qualification evidence and machine-specific load spectra intentionally remain outside Machinewright.

physical_dimensions
Section titled “physical_dimensions”
def physical_dimensions() -> DutyCycleRating

ElectricalInterface

Section titled “ElectricalInterface”

class in machinewright.contracts

class ElectricalInterface(InterfaceBase)

No description yet.

electrical_dimensions
Section titled “electrical_dimensions”
def electrical_dimensions() -> ElectricalInterface

evaluate_motor_compatibility

Section titled “evaluate_motor_compatibility”

function in machinewright.contracts

def evaluate_motor_compatibility(
    spec: MotorSpec,
    requirement: MotorRequirement
) -> ValidationReport

No description yet.

FeedbackInterface

Section titled “FeedbackInterface”

class in machinewright.contracts

class FeedbackInterface(InterfaceBase)

No description yet.

FinishRequirement

Section titled “FinishRequirement”

class in machinewright.contracts

class FinishRequirement(Contract)

No description yet.

InspectionRequirement

Section titled “InspectionRequirement”

class in machinewright.contracts

class InspectionRequirement(Contract)

No description yet.

interfaces_compatible

Section titled “interfaces_compatible”

function in machinewright.contracts

def interfaces_compatible(
    candidate: InterfaceSpec,
    required: InterfaceSpec,
    require_identity: bool = True
) -> bool

No description yet.

ManufacturerPartIdentity

Section titled “ManufacturerPartIdentity”

class in machinewright.contracts

class ManufacturerPartIdentity(Contract)

No description yet.

MaterialSpec

Section titled “MaterialSpec”

class in machinewright.contracts

class MaterialSpec(Contract)

No description yet.

density_dimension
Section titled “density_dimension”
def density_dimension() -> MaterialSpec

MechanicalMountInterface

Section titled “MechanicalMountInterface”

class in machinewright.contracts

class MechanicalMountInterface(InterfaceBase)

No description yet.

MotorOperatingPoint

Section titled “MotorOperatingPoint”

class in machinewright.contracts

class MotorOperatingPoint(Contract)

A guaranteed torque envelope at or below a stated motor speed.

physical_dimensions
Section titled “physical_dimensions”
def physical_dimensions() -> MotorOperatingPoint

MotorRequirement

Section titled “MotorRequirement”

class in machinewright.contracts

class MotorRequirement(Contract)

No description yet.

MotorSpec

Section titled “MotorSpec”

class in machinewright.contracts

class MotorSpec(Contract)

No description yet.

physical_dimensions
Section titled “physical_dimensions”
def physical_dimensions() -> MotorSpec

ProcessSpec

Section titled “ProcessSpec”

class in machinewright.contracts

class ProcessSpec(Contract)

No description yet.

Quantity

Section titled “Quantity”

class in machinewright.contracts

class Quantity(BaseModel)

No description yet.

finite
Section titled “finite”
def finite(
    value: Decimal
) -> Decimal
canonical_value
Section titled “canonical_value”
def canonical_value() -> Decimal
to
Section titled “to”
def to(
    unit: Unit
) -> Quantity

QuantityConstraint

Section titled “QuantityConstraint”

class in machinewright.contracts

class QuantityConstraint(Contract)

No description yet.

bounds
Section titled “bounds”
def bounds() -> QuantityConstraint

ShaftInterface

Section titled “ShaftInterface”

class in machinewright.contracts

class ShaftInterface(InterfaceBase)

No description yet.

length_dimensions
Section titled “length_dimensions”
def length_dimensions() -> ShaftInterface

ThermalInterface

Section titled “ThermalInterface”

class in machinewright.contracts

class ThermalInterface(InterfaceBase)

No description yet.

temperature_dimensions
Section titled “temperature_dimensions”
def temperature_dimensions() -> ThermalInterface

Tolerance

Section titled “Tolerance”

class in machinewright.contracts

class Tolerance(Contract)

No description yet.

compatible
Section titled “compatible”
def compatible() -> Tolerance
add
Section titled “add”
def add(
    other: Tolerance
) -> Tolerance
subtract
Section titled “subtract”
def subtract(
    other: Tolerance
) -> Tolerance

Unit

Section titled “Unit”

class in machinewright.contracts

class Unit(StrEnum)

No description yet.