11055873027

Committed 26 Sep 2024 03:54PM UTC coverage: 88.242% (-0.1%) from 88.36%

Build # 11055873027

Build Type

Pull #659

github

Committed by

vtnate

Commit Message

Merge branch 'develop' into simplify-sys-params

Pull Request Pull Request #659: Simplify sys params to closer match reality

Run Details

1010 of 1228 branches covered (82.25%)

Branch coverage included in aggregate %.

2 of 6 new or added lines in 1 file covered. (33.33%)

12 existing lines in 1 file now uncovered.

2780 of 3067 relevant lines covered (90.64%)

1.81 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.3

/geojson_modelica_translator/utils.py

# :copyright (c) URBANopt, Alliance for Sustainable Energy, LLC, and other contributors.
# See also https://github.com/urbanopt/geojson-modelica-translator/blob/develop/LICENSE.md

import json
import logging
import os
import shutil
from pathlib import Path
from uuid import uuid4

logger = logging.getLogger(__name__)


def copytree(src, dst, symlinks=False, ignore=None):
    """Alternate version of copytree that will work if the directory already exists (use instead of shutil)"""
    for item in os.listdir(src):
        s = os.path.join(src, item)
        d = os.path.join(dst, item)
        if os.path.isdir(s):
            shutil.copytree(s, d, symlinks, ignore)
        else:
            shutil.copy2(s, d)


def convert_c_to_k(c):
    """Converts a temperature in celsius to kelvin

    :param c: float, temperature in celsius
    :return: float, temperature in kelvin
    """
    return c + 273.15


def convert_ft_to_m(f):
    """Converts a length in foot to meter

    :param f: float, length in ft
    :return: float, length in meter
    """
    return 0.3048 * f


def load_loop_order(system_parameters_file: Path) -> list:
    """Loads the loop order from a JSON file

    loop_order file is always saved next to the system parameters file

    :param system_parameters_file: Path to the system parameters file
    :return: list of building & ghe ids in loop order
    """
    loop_order_path = Path(system_parameters_file).parent / "_loop_order.json"
    if not loop_order_path.is_file():
        raise FileNotFoundError(f"Loop order file not found at {loop_order_path}")
    return json.loads(loop_order_path.read_text())


def linecount(filename: Path) -> int:
    """Counts the number of lines in a file
    Probably not the most efficient way to do this, but it works
    """
    with open(filename) as f:
        filelength = len(f.readlines())
    return filelength


def mbl_version():
    """Returns the version of the Modelica Buildings Library (MBL) used by the
    geojson-modelica-translator.
    """
    return "10.0.0"


class ModelicaPath:
    """Class for storing Modelica paths. This allows the path to point to
    the model directory, resources, and scripts directory.
    """

    def __init__(self, name, root_dir, overwrite=False):
        """Create a new modelica-based path with name of 'name'

        :param name: Name to create
        """
        self.name = name
        self.root_dir = root_dir
        self.overwrite = overwrite

        # create the directories
        if root_dir is not None:
            check_path = os.path.join(self.files_dir)
            self.clear_or_create_path(check_path)
            check_path = os.path.join(self.resources_dir)
            self.clear_or_create_path(check_path)
            check_path = os.path.join(self.scripts_dir)
            self.clear_or_create_path(check_path)

    def clear_or_create_path(self, path):
        if os.path.exists(path):
            if not self.overwrite:
                raise Exception(f"Directory already exists and overwrite is false for {path}")
            else:
                shutil.rmtree(path)
        os.makedirs(path, exist_ok=True)

    @property
    def files_dir(self):
        """Return the path to the files (models) for the specified ModelicaPath. This path does not include the
        trailing slash.

        :return: string, path to where files (models) are stored, without trailing slash
        """
        if self.root_dir is None:
            return self.files_relative_dir
        else:
            return f"{self.root_dir}/{self.name}"

    @property
    def resources_relative_dir(self):
        """Return the relative resource directory instead of the full path. This is useful when replacing
        strings within modelica files which are relative to the package.

        :return: string, relative resource's data path
        """
        return f"Resources/Data/{self.name}"

    @property
    def scripts_relative_dir(self, platform="Dymola"):  # noqa: PLR0206
        # FIXME: https://docs.astral.sh/ruff/rules/property-with-parameters/
        """Return the scripts directory that is in the resources directory. This only returns the
        relative directory and is useful when replacing string values within Modelica files.

        :return: string, relative scripts path
        """
        return f"Resources/Scripts/{self.name}/{platform}"

    @property
    def files_relative_dir(self):
        """Return the path to the files relative to the project name."""
        return os.path.join(self.name)

    @property
    def resources_dir(self):
        """Return the path to the resources directory for the specified ModelicaPath. This path does not include
        the trailing slash.

        :return: string, path to where resources are stored, without trailing slash.
        """
        if self.root_dir is None:
            return self.resources_relative_dir
        else:
            return f"{self.root_dir}/{self.resources_relative_dir}"

    @property
    def scripts_dir(self):
        """Return the path to the scripts directory (in the resources dir) for the specified ModelicaPath.
        This path does not include the trailing slash.

        :return: string, path to where scripts are stored, without trailing slash.
        """
        if self.root_dir is None:
            return self.scripts_relative_dir
        else:
            return f"{self.root_dir}/{self.scripts_relative_dir}"


# This is used for some test cases where we need deterministic IDs to be generated
USE_DETERMINISTIC_ID = bool(os.environ.get("GMT_DETERMINISTIC_ID", False))

counter = 0


def simple_uuid():
    """Generates a simple string uuid

    :return: string, uuid
    """
    global counter  # noqa: PLW0603

    if not USE_DETERMINISTIC_ID:
        return str(uuid4()).split("-")[0]
    else:
        string_id = str(counter)
        counter += 1
        return string_id

1	# :copyright (c) URBANopt, Alliance for Sustainable Energy, LLC, and other contributors.
2	# See also https://github.com/urbanopt/geojson-modelica-translator/blob/develop/LICENSE.md
3
4	import json	2✔
5	import logging	2✔
6	import os	2✔
7	import shutil	2✔
8	from pathlib import Path	2✔
9	from uuid import uuid4	2✔
10
11	logger = logging.getLogger(__name__)	2✔
12
13
14	def copytree(src, dst, symlinks=False, ignore=None):	2✔
15	"""Alternate version of copytree that will work if the directory already exists (use instead of shutil)"""
16	for item in os.listdir(src):	2✔
17	s = os.path.join(src, item)	2✔
18	d = os.path.join(dst, item)	2✔
19	if os.path.isdir(s):	2!
UNCOV 20	shutil.copytree(s, d, symlinks, ignore)	×
21	else:
22	shutil.copy2(s, d)	2✔
23
24
25	def convert_c_to_k(c):	2✔
26	"""Converts a temperature in celsius to kelvin
27
28	:param c: float, temperature in celsius
29	:return: float, temperature in kelvin
30	"""
31	return c + 273.15	2✔
32
33
34	def convert_ft_to_m(f):	2✔
35	"""Converts a length in foot to meter
36
37	:param f: float, length in ft
38	:return: float, length in meter
39	"""
40	return 0.3048 * f	2✔
41
42
43	def load_loop_order(system_parameters_file: Path) -> list:	2✔
44	"""Loads the loop order from a JSON file
45
46	loop_order file is always saved next to the system parameters file
47
48	:param system_parameters_file: Path to the system parameters file
49	:return: list of building & ghe ids in loop order
50	"""
NEW UNCOV 51	loop_order_path = Path(system_parameters_file).parent / "_loop_order.json"	×
NEW UNCOV 52	if not loop_order_path.is_file():	×
NEW UNCOV 53	raise FileNotFoundError(f"Loop order file not found at {loop_order_path}")	×
NEW UNCOV 54	return json.loads(loop_order_path.read_text())	×
55
56
57	def linecount(filename: Path) -> int:	2✔
58	"""Counts the number of lines in a file
59	Probably not the most efficient way to do this, but it works
60	"""
61	with open(filename) as f:	2✔
62	filelength = len(f.readlines())	2✔
63	return filelength	2✔
64
65
66	def mbl_version():	2✔
67	"""Returns the version of the Modelica Buildings Library (MBL) used by the
68	geojson-modelica-translator.
69	"""
70	return "10.0.0"	2✔
71
72
73	class ModelicaPath:	2✔
74	"""Class for storing Modelica paths. This allows the path to point to
75	the model directory, resources, and scripts directory.
76	"""
77
78	def __init__(self, name, root_dir, overwrite=False):	2✔
79	"""Create a new modelica-based path with name of 'name'
80
81	:param name: Name to create
82	"""
83	self.name = name	2✔
84	self.root_dir = root_dir	2✔
85	self.overwrite = overwrite	2✔
86
87	# create the directories
88	if root_dir is not None:	2✔
89	check_path = os.path.join(self.files_dir)	2✔
90	self.clear_or_create_path(check_path)	2✔
91	check_path = os.path.join(self.resources_dir)	2✔
92	self.clear_or_create_path(check_path)	2✔
93	check_path = os.path.join(self.scripts_dir)	2✔
94	self.clear_or_create_path(check_path)	2✔
95
96	def clear_or_create_path(self, path):	2✔
97	if os.path.exists(path):	2!
UNCOV 98	if not self.overwrite:	×
UNCOV 99	raise Exception(f"Directory already exists and overwrite is false for {path}")	×
100	else:
UNCOV 101	shutil.rmtree(path)	×
102	os.makedirs(path, exist_ok=True)	2✔
103
104	@property	2✔
105	def files_dir(self):	2✔
106	"""Return the path to the files (models) for the specified ModelicaPath. This path does not include the
107	trailing slash.
108
109	:return: string, path to where files (models) are stored, without trailing slash
110	"""
111	if self.root_dir is None:	2✔
112	return self.files_relative_dir	2✔
113	else:
114	return f"{self.root_dir}/{self.name}"	2✔
115
116	@property	2✔
117	def resources_relative_dir(self):	2✔
118	"""Return the relative resource directory instead of the full path. This is useful when replacing
119	strings within modelica files which are relative to the package.
120
121	:return: string, relative resource's data path
122	"""
123	return f"Resources/Data/{self.name}"	2✔
124
125	@property	2✔
126	def scripts_relative_dir(self, platform="Dymola"): # noqa: PLR0206	2✔
127	# FIXME: https://docs.astral.sh/ruff/rules/property-with-parameters/
128	"""Return the scripts directory that is in the resources directory. This only returns the
129	relative directory and is useful when replacing string values within Modelica files.
130
131	:return: string, relative scripts path
132	"""
133	return f"Resources/Scripts/{self.name}/{platform}"	2✔
134
135	@property	2✔
136	def files_relative_dir(self):	2✔
137	"""Return the path to the files relative to the project name."""
138	return os.path.join(self.name)	2✔
139
140	@property	2✔
141	def resources_dir(self):	2✔
142	"""Return the path to the resources directory for the specified ModelicaPath. This path does not include
143	the trailing slash.
144
145	:return: string, path to where resources are stored, without trailing slash.
146	"""
147	if self.root_dir is None:	2✔
148	return self.resources_relative_dir	2✔
149	else:
150	return f"{self.root_dir}/{self.resources_relative_dir}"	2✔
151
152	@property	2✔
153	def scripts_dir(self):	2✔
154	"""Return the path to the scripts directory (in the resources dir) for the specified ModelicaPath.
155	This path does not include the trailing slash.
156
157	:return: string, path to where scripts are stored, without trailing slash.
158	"""
159	if self.root_dir is None:	2!
UNCOV 160	return self.scripts_relative_dir	×
161	else:
162	return f"{self.root_dir}/{self.scripts_relative_dir}"	2✔
163
164
165	# This is used for some test cases where we need deterministic IDs to be generated
166	USE_DETERMINISTIC_ID = bool(os.environ.get("GMT_DETERMINISTIC_ID", False))	2✔
167
168	counter = 0	2✔
169
170
171	def simple_uuid():	2✔
172	"""Generates a simple string uuid
173
174	:return: string, uuid
175	"""
176	global counter # noqa: PLW0603
177
178	if not USE_DETERMINISTIC_ID:	2!
179	return str(uuid4()).split("-")[0]	2✔
180	else:
UNCOV 181	string_id = str(counter)	×
UNCOV 182	counter += 1	×
UNCOV 183	return string_id	×

urbanopt / geojson-modelica-translator / 11055873027

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous