type hints and docstring inconsistent with implementation

Lines 118 and 119 use the .value attribute material_name, datasource, ... are Enums as defined in enumerations.py

materialdatabase/materialdatabase/material_data_base_classes.py

Lines 92 to 120 in 850ac22

    
               def get_permeability_data(self, temperature: float, frequency: float, material_name: str, datatype: str, datasource: str = None, 
        
                                         measurement_setup: str = None, plot_interpolation: bool = False): 
        
                   """ 
        
                   Read permeability data from the material database. 
        
                   :param temperature: temperature in °C 
        
                   :type temperature: float 
        
                   :param frequency: Frequency in Hz 
        
                   :type frequency: float 
        
                   :param material_name: "N95","N87".... 
        
                   :type material_name: str 
        
                   :param datatype: "complex_permeability", "complex_permittivity" or "Steinmetz" 
        
                   :type datatype: str 
        
                   :param datasource: "measurements" or "manufacturer_datasheet" 
        
                   :type datasource: str 
        
                   :param measurement_setup: name of measuerement setup 
        
                   :type measurement_setup: str 
        
                   :param plot_interpolation: enables interpolation for plots 
        
                   :type plot_interpolation: bool 
        
                   :return: 
        
                   """ 
        
                   self.mdb_print(f"{material_name=}\n") 
        
                   self.mdb_print(f"{datatype=}\n") 
        
                   self.mdb_print(f"{measurement_setup=}\n") 
        
                   if datasource == MaterialDataSource.ManufacturerDatasheet: 
        
                       permeability_data = self.data[f"{material_name.value}"][f"{datasource.value}"]["permeability_data"] 
        
                   elif datasource == MaterialDataSource.Measurement: 
        
                       permeability_data = self.data[f"{material_name.value}"]["measurements"][f"{datatype.value}"][f"{measurement_setup.value}"]["measurement_data"]

mypy catches these:

materialdatabase\material_data_base_classes.py:118: error: "str" has no attribute "value"  [attr-defined]
materialdatabase\material_data_base_classes.py:120: error: "str" has no attribute "value"  [attr-defined]

Navigation Menu

Repository navigation

type hints and docstring inconsistent with implementation #26

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	def get_permeability_data(self, temperature: float, frequency: float, material_name: str, datatype: str, datasource: str = None,
	measurement_setup: str = None, plot_interpolation: bool = False):
	"""
	Read permeability data from the material database.

	:param temperature: temperature in °C
	:type temperature: float
	:param frequency: Frequency in Hz
	:type frequency: float
	:param material_name: "N95","N87"....
	:type material_name: str
	:param datatype: "complex_permeability", "complex_permittivity" or "Steinmetz"
	:type datatype: str
	:param datasource: "measurements" or "manufacturer_datasheet"
	:type datasource: str
	:param measurement_setup: name of measuerement setup
	:type measurement_setup: str
	:param plot_interpolation: enables interpolation for plots
	:type plot_interpolation: bool
	:return:
	"""
	self.mdb_print(f"{material_name=}\n")
	self.mdb_print(f"{datatype=}\n")
	self.mdb_print(f"{measurement_setup=}\n")

	if datasource == MaterialDataSource.ManufacturerDatasheet:
	permeability_data = self.data[f"{material_name.value}"][f"{datasource.value}"]["permeability_data"]
	elif datasource == MaterialDataSource.Measurement:
	permeability_data = self.data[f"{material_name.value}"]["measurements"][f"{datatype.value}"][f"{measurement_setup.value}"]["measurement_data"]

type hints and docstring inconsistent with implementation #26

Description

Activity

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions