honeybee-core 1.61.21__py2.py3-none-any.whl → 1.61.22__py2.py3-none-any.whl

honeybee/cli/validate.py

@@ -21,10 +21,13 @@ def validate():
     '--extension', '-e', help='Text for the name of the extension to be checked. '
     'The value input is case-insensitive such that "radiance" and "Radiance" will '
     'both result in the model being checked for validity with honeybee-radiance. '
-    'This value can also be set to "All" in order to run checks for all installed '
-    'extensions. Some common honeybee extension names that can be input here include: '
-    'Radiance, EnergyPlus, DOE2, IES, IDAICE',
-    type=str, default='All', show_default=True)
+    'This value can also be set to "Generic" in order to run checks for all installed '
+    'extensions. Using "Generic" will run all except the most limiting of checks '
+    '(eg. the DOE2 lack of support for courtyards) with the goal of producing a model '
+    'that can be exported to multiple engines (albeit with a little extra '
+    'postprocessing for particularly limited engines). Some common honeybee extension '
+    'names that can be input here include: Radiance, EnergyPlus, DOE2, IES, IDAICE',
+    type=str, default='Generic', show_default=True)
 @click.option(
     '--plain-text/--json', ' /-j', help='Flag to note whether the output validation '
     'report should be formatted as a JSON object instead of plain text. If set to JSON, '
@@ -82,7 +85,7 @@ def validate_model_cli(model_file, extension, plain_text, room_overlaps, output_
         sys.exit(0)
 
 
-def validate_model(model_file, extension='All', json=False, output_file=None,
+def validate_model(model_file, extension='Generic', json=False, output_file=None,
                    plain_text=True):
     """Validate all properties of a Model file against the Honeybee schema.
 
@@ -95,8 +98,12 @@ def validate_model(model_file, extension='All', json=False, output_file=None,
             The value input here is case-insensitive such that "radiance"
             and "Radiance" will both result in the model being checked for
             validity with honeybee-radiance. This value can also be set to
-            "All" in order to run checks for all installed extensions. Some
-            common honeybee extension names that can be input here if they
+            "Generic" in order to run checks for all installed extensions.
+            Using "Generic" will run all except the most limiting of checks
+            (eg. DOE2's lack of support for courtyards) with the goal of
+            producing a model that is export-able to multiple engines (albeit
+            with a little extra postprocessing for particularly limited engines).
+            Some common dragonfly extension names that can be input here if they
             are installed include:
 
             * Radiance

honeybee/model.py

@@ -2102,7 +2102,7 @@ class Model(_Base):
             compare_dict['deleted_objects'] = deleted
         return compare_dict
 
-    def check_for_extension(self, extension_name='All',
+    def check_for_extension(self, extension_name='Generic',
                             raise_exception=True, detailed=False):
         """Check that the Model is valid for a specific Honeybee extension.
 
@@ -2118,9 +2118,13 @@ class Model(_Base):
                 The value input here is case-insensitive such that "radiance"
                 and "Radiance" will both result in the model being checked for
                 validity with honeybee-radiance. This value can also be set to
-                "All" in order to run checks for all installed extensions. Some
-                common honeybee extension names that can be input here if they
-                are installed include:
+                "Generic" in order to run checks for all installed extensions.
+                Using "Generic" will run all except the most limiting of
+                checks (eg. DOE2's lack of support for courtyards) with the
+                goal of producing a model that is export-able to multiple
+                engines (albeit with a little extra postprocessing for
+                particularly limited engines). Some common honeybee extension
+                names that can be input here if they are installed include:
 
                 * Radiance
                 * EnergyPlus
@@ -2145,8 +2149,9 @@ class Model(_Base):
         # set up defaults to ensure the method runs correctly
         detailed = False if raise_exception else detailed
         extension_name = extension_name.lower()
-        if extension_name == 'all':
-            return self.check_all(raise_exception, detailed)
+        if extension_name in ('all', 'generic'):
+            all_ext_checks = extension_name == 'all'
+            return self.check_all(raise_exception, detailed, all_ext_checks)
         energy_extensions = ('energyplus', 'openstudio', 'designbuilder')
         if extension_name in energy_extensions:
             extension_name = 'energy'
@@ -2171,8 +2176,8 @@ class Model(_Base):
             raise ValueError(full_msg)
         return full_msg
 
-    def check_all(self, raise_exception=True, detailed=False):
-        """Check all of the aspects of the Model for possible errors.
+    def check_all(self, raise_exception=True, detailed=False, all_ext_checks=False):
+        """Check all of the aspects of the Model for validation errors.
 
         This includes basic properties like adjacency checks and all geometry checks.
         Furthermore, all extension attributes will be checked assuming the extension
@@ -2186,6 +2191,12 @@ class Model(_Base):
                 return a text string with all errors that were found. (Default: True).
             detailed: Boolean for whether the returned object is a detailed list of
                 dicts with error info or a string with a message. (Default: False).
+            all_ext_checks: Boolean to note whether every single check that is
+                available for all installed extensions should be run (True) or only
+                generic checks that cover all except the most limiting of
+                cases should be run (False). Examples of checks that are skipped
+                include DOE2's lack of support for courtyards and floor plates
+                with holes. (Default: False).
 
         Returns:
             A text string with all errors that were found or a list if detailed is True.
@@ -2224,7 +2235,7 @@ class Model(_Base):
         msgs.append(self.check_all_air_boundaries_adjacent(False, detailed))
 
         # check the extension attributes
-        ext_msgs = self._properties._check_all_extension_attr(detailed)
+        ext_msgs = self._properties._check_all_extension_attr(detailed, all_ext_checks)
         if detailed:
             ext_msgs = [m for m in ext_msgs if isinstance(m, list)]
         msgs.extend(ext_msgs)

honeybee/properties.py

@@ -436,7 +436,7 @@ class ModelProperties(_Properties):
                                     'for {}: {}'.format(var, e))
         return msgs
 
-    def _check_all_extension_attr(self, detailed=False):
+    def _check_all_extension_attr(self, detailed=False, all_ext_checks=False):
         """Check the attributes of all extensions.
 
         This method should be called within the check_all method of the Model object
@@ -449,24 +449,41 @@ class ModelProperties(_Properties):
         """
         msgs = []
         for atr in self._extension_attributes:
+            # get the extension attributes
             check_msg = None
             var = getattr(self, atr)
-            if not hasattr(var, 'check_all'):
-                continue
-            try:
+            # use the check_generic function if it is available
+            if not all_ext_checks and hasattr(var, 'check_generic'):
                 try:
-                    check_msg = var.check_all(raise_exception=False, detailed=detailed)
-                except TypeError:  # no option available for detailed error message
-                    check_msg = var.check_all(raise_exception=False)
-                if detailed and check_msg is not None:
-                    msgs.append(check_msg)
-                elif check_msg != '':
-                    f_msg = 'Attributes for {} are invalid.\n{}'.format(atr, check_msg)
-                    msgs.append(f_msg)
-            except Exception as e:
-                import traceback
-                traceback.print_exc()
-                raise Exception('Failed to check_all for {}: {}'.format(var, e))
+                    check_msg = var.check_generic(
+                        raise_exception=False, detailed=detailed)
+                    if detailed and check_msg is not None:
+                        msgs.append(check_msg)
+                    elif check_msg != '':
+                        f_msg = \
+                            'Attributes for {} are invalid.\n{}'.format(atr, check_msg)
+                        msgs.append(f_msg)
+                except Exception as e:
+                    import traceback
+                    traceback.print_exc()
+                    raise Exception('Failed to check_generic for {}: {}'.format(var, e))
+            elif hasattr(var, 'check_all'):  # use the check_all function
+                try:
+                    try:
+                        check_msg = var.check_all(
+                            raise_exception=False, detailed=detailed)
+                    except TypeError:  # no option available for detailed error message
+                        check_msg = var.check_all(raise_exception=False)
+                    if detailed and check_msg is not None:
+                        msgs.append(check_msg)
+                    elif check_msg != '':
+                        f_msg = \
+                            'Attributes for {} are invalid.\n{}'.format(atr, check_msg)
+                        msgs.append(f_msg)
+                except Exception as e:
+                    import traceback
+                    traceback.print_exc()
+                    raise Exception('Failed to check_all for {}: {}'.format(var, e))
         return msgs
 
     def __repr__(self):

{honeybee_core-1.61.21.dist-info → honeybee_core-1.61.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-core
-Version: 1.61.21
+Version: 1.61.22
 Summary: A library to create 3D building geometry for various types of environmental simulation.
 Home-page: https://github.com/ladybug-tools/honeybee-core
 Author: Ladybug Tools
@@ -14,8 +14,8 @@ Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: ladybug-core==0.44.15
-Requires-Dist: ladybug-geometry-polyskel==1.7.26
+Requires-Dist: ladybug-core==0.44.16
+Requires-Dist: ladybug-geometry-polyskel==1.7.27
 Requires-Dist: honeybee-schema==1.59.0; python_version >= "3.7"
 
 ![Honeybee](https://www.ladybug.tools/assets/img/honeybee.png)

{honeybee_core-1.61.21.dist-info → honeybee_core-1.61.22.dist-info}/RECORD

@@ -16,9 +16,9 @@ honeybee/extensionutil.py,sha256=DDQYhM7tFD3avRSCOjwTzLqX9ldUxl5GzY79V3_sATE,964
 honeybee/face.py,sha256=j_0YPI-dZGQQZ8CJNUtmO2LC-IfpVA_Fwp7ivOoBl6Y,107622
 honeybee/facetype.py,sha256=vCtWZKHp21RH-Yzs8zsHJHuFhJvczNh0yFl8wDe_RWY,4489
 honeybee/logutil.py,sha256=2gn-6RcWqFLvwdFzBHPqUwFqTj_R3iwHKALrl-2eL7M,2564
-honeybee/model.py,sha256=RZIh4MpxYP-3g05536FUJUVmosCRDtWxtQaHwzTP954,174201
+honeybee/model.py,sha256=RZhj195_Nr5jlUauEOo7H5ZdNZDdKyBb2kwhDxRB1oI,175099
 honeybee/orientation.py,sha256=GogGblASW9OU-fobfDaQ7w5yRbEAFdJJuHwg2fadhKI,5046
-honeybee/properties.py,sha256=bJ8Zm6Q1ZSDYnlbKGWW_BOlfStm3VhCBM5T_abUeqp4,32488
+honeybee/properties.py,sha256=fnlT71in22HpFQGD8ta5kXNnSZVXwXq5cNgvD-hrMRg,33462
 honeybee/room.py,sha256=Ga91VmqBTJqYyCY5bX5kHnf3zMe9reG-tHqFOTeWdSc,148639
 honeybee/search.py,sha256=OiXibGGVb1ff4gTn_768i-sehB-zAYG12c0o3B0RjKE,4718
 honeybee/shade.py,sha256=G_ujmsPQeKvcc0O1ICiFRhVkjypkKBbgY9wJKck-9uU,19393
@@ -31,7 +31,7 @@ honeybee/cli/create.py,sha256=6KmnetAzhwrCuAIDZnySbEKnEssPIxJ72JK-51fBCKU,13067
 honeybee/cli/edit.py,sha256=Iost_FqgUGbTWQL0jhn5aPWCQnsX8QxxUUrClUWMjao,27579
 honeybee/cli/lib.py,sha256=8udazsVycqMHfk5ZQIOvy4tKM3FuSzjMPCeMuFC2rck,4436
 honeybee/cli/setconfig.py,sha256=S7DfatGyIPkHxImBDyT9JUhKGuflmd3h5nMfVbzcg9g,1428
-honeybee/cli/validate.py,sha256=1xbZS8DFGXfHd70vcN9AI1HEopWSa0nCrFzNsZ_Kbd0,9778
+honeybee/cli/validate.py,sha256=aPOShUwjw8CLeqU52IgVzupEbwl8wKWJtn3RIn-UEB0,10389
 honeybee/writer/__init__.py,sha256=Gz05beUglVhr-v8H-WemfvGWsOFfQIgNmgp2upCeVmw,245
 honeybee/writer/aperture.py,sha256=5TmuhehgSPiZiYuI94DR-xqG2kEOPv8uEZiHqoeUTfI,186
 honeybee/writer/door.py,sha256=ja3r94CnloDB06xedXVB5_mS-8kKkTGl4_7JXPYxBtE,174
@@ -40,9 +40,9 @@ honeybee/writer/model.py,sha256=N7F_jksf-5TrdVecuxTaFWxnPVFLmQs7k8g27TsdB7Q,177
 honeybee/writer/room.py,sha256=kFghgStTU1SEJSLigXB0VjOWhZtgs4uXuAqdwd4yRQo,174
 honeybee/writer/shade.py,sha256=EpgX-vMc-s21TnMvNWvWTKyT8iAnxu1nFVXzjY1oyF8,177
 honeybee/writer/shademesh.py,sha256=Y41bLogJ7dwpvMe5cAWVRDRVqJEwo9e5hFJQjlt6UX8,189
-honeybee_core-1.61.21.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_core-1.61.21.dist-info/METADATA,sha256=48Xukqg9pO0t8GjbkRsA3azzV_FDmRE71WvbNJQ3Eaw,3317
-honeybee_core-1.61.21.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-honeybee_core-1.61.21.dist-info/entry_points.txt,sha256=r3YqOm40goBroH3ccUhpwQjvTwu10JWLd0HIRHI1J8E,47
-honeybee_core-1.61.21.dist-info/top_level.txt,sha256=8ve7puCRLUA9XDEGc1Mcs-UX9sFjpPV8MeTaIMwQ_Tg,9
-honeybee_core-1.61.21.dist-info/RECORD,,
+honeybee_core-1.61.22.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_core-1.61.22.dist-info/METADATA,sha256=5aj53yDHt2gno8ipT2Qtaadkm8m_qIHwx27wIiUn-cM,3317
+honeybee_core-1.61.22.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+honeybee_core-1.61.22.dist-info/entry_points.txt,sha256=r3YqOm40goBroH3ccUhpwQjvTwu10JWLd0HIRHI1J8E,47
+honeybee_core-1.61.22.dist-info/top_level.txt,sha256=8ve7puCRLUA9XDEGc1Mcs-UX9sFjpPV8MeTaIMwQ_Tg,9
+honeybee_core-1.61.22.dist-info/RECORD,,