Refactor create examples

doc/news/refactor-create-examples.rst

@@ -0,0 +1,11 @@
+**Added:**
+
+* Added ``Entry.create_example(name=None)`` which returns a single example entry. Defaults to ``'alves_2011_electrochemistry_6010_f1a_solid'`` when no name is provided.
+
+**Changed:**
+
+* Changed ``Collection.create_example`` to use ``Collection.from_local`` internally.
+
+**Removed:**
+
+* Removed ``Entry.create_examples``. Use ``Entry.create_example`` instead.

unitpackage/collection.py

@@ -47,6 +47,7 @@
 #  along with unitpackage. If not, see <https://www.gnu.org/licenses/>.
 # ********************************************************************
 import logging
+import os.path
 
 from frictionless import Package
 
@@ -121,21 +122,9 @@ def create_example(cls):
             Entry('no_bibliography')]
 
         """
+        example_dir = os.path.join(os.path.dirname(__file__), "..", "examples", "local")
 
-        entries = (
-            cls.Entry.create_examples("alves_2011_electrochemistry_6010")
-            + cls.Entry.create_examples("engstfeld_2018_polycrystalline_17743")
-            + cls.Entry.create_examples("no_bibliography")
-        )
-
-        package = Package()
-
-        for entry in entries:
-            package.add_resource(entry.resource)
-
-        return cls(
-            package=package,
-        )
+        return cls.from_local(example_dir)
 
     def filter(self, predicate):
         r"""

unitpackage/database/echemdb_entry.py

@@ -95,7 +95,7 @@ def __repr__(self):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry
             Echemdb('alves_2011_electrochemistry_6010_f1a_solid')
 
@@ -109,14 +109,14 @@ def bibliography(self):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry.bibliography # doctest: +NORMALIZE_WHITESPACE
             Entry('article',
             fields=[
                 ('title', ...
                 ...
 
-            >>> entry_no_bib = EchemdbEntry.create_examples(name="no_bibliography")[0]
+            >>> entry_no_bib = EchemdbEntry.create_example(name="no_bibliography")
             >>> entry_no_bib.bibliography
             ''
 
@@ -144,7 +144,7 @@ def citation(self, backend="text"):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry.citation(backend='text')
             'O. B. Alves et al. Electrochemistry at Ru(0001) in a flowing CO-saturated electrolyte—reactive and inert adlayer phases. Physical Chemistry Chemical Physics, 13(13):6010–6021, 2011.'
             >>> print(entry.citation(backend='md'))
@@ -210,7 +210,7 @@ def get_electrode(self, name):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry.get_electrode('WE') # doctest: +NORMALIZE_WHITESPACE
             {'name': 'WE', 'function': 'workingElectrode', 'type': 'single crystal',
             'crystallographicOrientation': '0001', 'material': 'Ru',
@@ -245,7 +245,7 @@ def rescale(self, units):
         These units must be defined in the metadata of the resource,
         within the key ``figureDescription.fields``::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> rescaled_entry = entry.rescale(units='original')
             >>> rescaled_entry.fields # doctest: +NORMALIZE_WHITESPACE
             [{'name': 't', 'type': 'number', 'unit': 's'},
@@ -270,7 +270,7 @@ def scan_rate(self):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry.scan_rate
             <Quantity 0.05 V / s>
 
@@ -297,7 +297,7 @@ def rescale_scan_rate(self, field_name=None, *, value, unit):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry.scan_rate
             <Quantity 0.05 V / s>
 
@@ -361,7 +361,7 @@ def _normalize_field_name(self, field_name):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry._normalize_field_name('j')
             'j'
             >>> entry._normalize_field_name('x')
@@ -382,7 +382,7 @@ def thumbnail(self, width=96, height=72, dpi=72, **kwds):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> thumb = entry.thumbnail()
             >>> thumb.startswith(b'\x89PNG')
             True
@@ -432,7 +432,7 @@ def plot(self, x_label="E", y_label="j", name=None):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry.plot()
             Figure(...)
 
@@ -496,7 +496,7 @@ def rescale_reference(self, new_reference=None, field_name=None, ph=None):
 
         EXAMPLES::
 
-            >>> entry = EchemdbEntry.create_examples()[0]
+            >>> entry = EchemdbEntry.create_example()
             >>> entry.resource.schema.get_field('E') # doctest: +NORMALIZE_WHITESPACE
             {'name': 'E', 'type': 'number', 'unit': 'V', 'reference': 'RHE'}
 

unitpackage/descriptor.py

@@ -170,7 +170,7 @@ class QuantityDescriptor(GenericDescriptor):
     EXAMPLES::
 
         >>> from unitpackage.entry import Entry
-        >>> entry = Entry.create_examples()[0]
+        >>> entry = Entry.create_example()
         >>> temperature = entry.echemdb.system.electrolyte.temperature
         >>> temperature
         298.15 K
@@ -187,7 +187,7 @@ def quantity(self):
         EXAMPLES::
 
             >>> from unitpackage.entry import Entry
-            >>> entry = Entry.create_examples()[0]
+            >>> entry = Entry.create_example()
             >>> temperature = entry.echemdb.system.electrolyte.temperature
             >>> temperature.quantity
             <Quantity 298.15 K>
@@ -204,7 +204,7 @@ def __repr__(self):
         EXAMPLES::
 
             >>> from unitpackage.entry import Entry
-            >>> entry = Entry.create_examples()[0]
+            >>> entry = Entry.create_example()
             >>> temperature = entry.echemdb.system.electrolyte.temperature
             >>> temperature
             298.15 K