Merge pull request #202 from gaiaresources/BDRSPS-787

BDRSPS-787 Removed instructions method from mapper and removed instructions pdf files for new draft templates.

abis_mapping/base/mapper.py

@@ -33,9 +33,6 @@ class ABISMapper(abc.ABC):
     # ABIS Mapper Registry
     registry: dict[str, type["ABISMapper"]] = {}
 
-    # ABIS Mapper Template ID and Instructions File
-    instructions_file: str = NotImplemented  # Must be implemented
-
     # Default Dataset Metadata
     DATASET_DEFAULT_NAME = "Example Dataset"
     DATASET_DEFAULT_DESCRIPTION = "Example Dataset by Gaia Resources"
@@ -348,22 +345,6 @@ def fields(cls) -> dict[str, types.schema.Field]:
         # Return dictionary of fields
         return {f.name: f for f in schema.fields}
 
-    @final
-    @classmethod
-    @functools.lru_cache
-    def instructions(cls) -> pathlib.Path:
-        """Retrieves and Caches the Template Instructions
-
-        Returns:
-            pathlib.Path: Filepath for this Template's Instructions
-        """
-        # Retrieve Template Filepath
-        directory = pathlib.Path(inspect.getfile(cls)).parent
-        instructions_file = directory / cls.instructions_file
-
-        # Return
-        return instructions_file
-
     @final
     @classmethod
     def register_mapper(

abis_mapping/templates/incidental_occurrence_data_v3/mapping.py

@@ -60,9 +60,6 @@
 class IncidentalOccurrenceMapper(base.mapper.ABISMapper):
     """ABIS Mapper for `incidental_occurrence_data.csv` - version 3"""
 
-    # Instructions File
-    instructions_file = "instructions.pdf"
-
     # Default Dataset Metadata
     DATASET_DEFAULT_NAME = "Example Incidental Occurrence Dataset"
     DATASET_DEFAULT_DESCRIPTION = "Example Incidental Occurrence Dataset by Gaia Resources"

abis_mapping/templates/survey_metadata_v2/mapping.py

@@ -53,9 +53,6 @@ class AttributeValue:
 class SurveyMetadataMapper(base.mapper.ABISMapper):
     """ABIS mapper for `survey_metadata.csv` v2"""
 
-    # Instructions filename
-    instructions_file = "instructions.pdf"
-
     # Default Dataset Metadata
     DATASET_DEFAULT_NAME = "Example Systematic Survey Metadata Dataset"
     DATASET_DEFAULT_DESCRIPTION = "Example Systematic Survey Metadata Dataset by Gaia Resources"

abis_mapping/templates/survey_occurrence_data_v2/mapping.py

@@ -65,9 +65,6 @@
 class SurveyOccurrenceMapper(base.mapper.ABISMapper):
     """ABIS Mapper for `survey_occurrence_data.csv` v2"""
 
-    # Instructions File
-    instructions_file = "instructions.pdf"
-
     # Default Dataset Metadata
     DATASET_DEFAULT_NAME = "Example Systematic Survey Occurrence Dataset"
     DATASET_DEFAULT_DESCRIPTION = "Example Systematic Survey Occurrence Dataset by Gaia Resources"

abis_mapping/templates/survey_site_data_v2/mapping.py

@@ -51,9 +51,6 @@ class Agent:
 class SurveySiteMapper(base.mapper.ABISMapper):
     """ABIS Mapper for `survey_site_data.csv` v2"""
 
-    # Instructions File
-    instructions_file = "instructions.pdf"
-
     # Default Dataset Metadata
     DATASET_DEFAULT_NAME = "Example Systematic Survey Site Dataset"
     DATASET_DEFAULT_DESCRIPTION = "Example Systematic Survey Site Dataset by Gaia Resources"

tests/templates/test_common.py

@@ -98,15 +98,6 @@ def test_get_schema(self, test_params: conftest.TemplateTestParameters) -> None:
         schema = real_mapper.schema()
         assert isinstance(schema, dict)
 
-    def test_get_instructions(self, test_params: conftest.TemplateTestParameters) -> None:
-        """Tests able to retrieve template instructions."""
-        # Test Real Template ID
-        real_mapper = abis_mapping.base.mapper.get_mapper(test_params.template_id)
-        assert real_mapper is not None
-        instructions = real_mapper.instructions()
-        assert isinstance(instructions, pathlib.Path)
-        assert instructions.is_file()
-
     def test_geodetic_datum_proj_supported(self, test_params: conftest.TemplateTestParameters) -> None:
         """Test that all enumerated values for geodeticDatum are supported by proj."""
         # Get mapper