Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

function to match a native TIA portal export to a DB layout specification string #533

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

function to match a native TIA portal export to a DB layout specification string #533

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
01056f0
first try
Novecento99 Sep 10, 2024
77d3ad8
first try
Novecento99 Sep 10, 2024
dce354f
str as return
Novecento99 Sep 10, 2024
976e6fa
newline at the end of file
Novecento99 Sep 10, 2024
7bee9e9
spazi
Novecento99 Sep 10, 2024
8db4c35
altri spazi
Novecento99 Sep 10, 2024
82e8b4f
ok
Novecento99 Sep 10, 2024
c08e5ca
daje
Novecento99 Sep 10, 2024
df74126
lol
Novecento99 Sep 10, 2024
c4681c7
_instead of maiusc
Novecento99 Sep 10, 2024
fd1f948
ottimo
Novecento99 Sep 10, 2024
3a318ea
spazi
Novecento99 Sep 10, 2024
1392977
no ex
Novecento99 Sep 10, 2024
e97bc34
replaced the list with a set
Novecento99 Sep 23, 2024
e629448
removed usless check
Novecento99 Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 90 additions & 12 deletions snap7/util/db.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,60 @@
logger = getLogger(__name__)


def prepare_tia_export_to_parse(txt_path: str) -> str:
"""Return a string that can be ingested by parse_specification
from a .txt file directly copied and pasted from TIA Portal.
It also handles duplicate variable names by progressively appending “_X”.

Args:
tia_export: path to the .txt

Returns:
string ready to be parsed
"""

with open(txt_path, "r") as file:
db_specification = ""

valid_list = {
"BOOL",
"DWORD",
"INT",
"DINT",
"CHAR",
"STRING",
"DATE_AND_TIME",
"TIME_OF_DAY",
"REAL",
"BYTE",
}
var_names: list[str] = []

for line in file:
line = line.lstrip("\t")
parsed_line = line.split("\t")

var_name = parsed_line[0]
var_type = parsed_line[1].upper()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why the literals in valid_names are uppercase? If they were lowercase, you wouldn't need to call .upper() for every line

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

valid_names are list a copied from another part of this repo.
TIA portal exports variabiles types with the first letter in uppercase anyway

var_offset = parsed_line[2]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what the export file format looks like. Can there be empty lines or comments in it? This could cause an exception, something like 'list index out of range'

Copy link
Contributor Author

@Novecento99 Novecento99 Sep 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as far as I know: no.
this is an example of tia export:

PRESENT Bool 3968.0 false --- False True True True False PIECE PRESENT SCRAP Bool 3968.1 false --- False True True True False PIECE SCRAP READY Bool 3968.2 false --- False True True True False PIECE READY DRY_TEST Bool 3968.3 false --- False True True True False DRY TEST MOVING Bool 3968.4 false --- False True True True False PIECE MOVING SCANNED Bool 3968.5 false --- False True True True False QR_NOK Bool 3968.6 false --- False True True True False QR CODE NOT OK LONG_PROFILE Bool 3968.7 false --- False True True True False VB_ACK Bool 3969.0 false --- False True True True False


to_add = "_0"
for name in reversed(var_names):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think using a dictionary, where the key is var_name and the value is a counter, would be cleaner and more efficient than using a list. Something like this:

var_names: dict[str, int] = {}
to_add = var_names.setdefault(var_name, 0)
var_names[var_name] += 1
var_name = f'{var_name}_{to_add}'

And you won’t need an inner loop in this case.

name = str(name)
if name.rsplit("_")[0] == var_name:
print(name.rsplit("_")[-1])
to_add = "_" + str(int(name.rsplit("_")[-1]) + 1)
break

var_name = var_name + to_add
var_names.append(var_name)

if var_type in valid_list:
new_line = var_offset + "\t" + var_name + "\t" + var_type
db_specification = db_specification + "\n" + new_line
return db_specification


def parse_specification(db_specification: str) -> Dict[str, Any]:
"""Create a db specification derived from a
dataview of a db in which the byte layout
Expand Down Expand Up @@ -317,7 +371,9 @@ def make_rows(self) -> None:
logger.error(msg)
self.index[key] = row

def __getitem__(self, key: str, default: Optional[None] = None) -> Union[None, "Row"]:
def __getitem__(
self, key: str, default: Optional[None] = None
) -> Union[None, "Row"]:
"""Access a row of the table through its index.

Rows (values) are of type :class:`DB_Row`.
Expand Down Expand Up @@ -388,7 +444,9 @@ def set_data(self, bytearray_: bytearray) -> None:
:obj:`TypeError`: if `bytearray_` is not an instance of :obj:`bytearray`
"""
if not isinstance(bytearray_, bytearray):
raise TypeError(f"Value bytearray_: {bytearray_} is not from type bytearray")
raise TypeError(
f"Value bytearray_: {bytearray_} is not from type bytearray"
)
self._bytearray = bytearray_

def read(self, client: Client) -> None:
Expand Down Expand Up @@ -496,7 +554,9 @@ def __init__(
self.area = area

if not isinstance(bytearray_, (bytearray, DB)):
raise TypeError(f"Value bytearray_ {bytearray_} is not from type (bytearray, DB)")
raise TypeError(
f"Value bytearray_ {bytearray_} is not from type (bytearray, DB)"
)
self._bytearray = bytearray_
self._specification = parse_specification(_specification)

Expand Down Expand Up @@ -590,17 +650,23 @@ def get_value(self, byte_index: Union[str, int], type_: str) -> ValueType:
if type_.startswith("FSTRING"):
max_size = re.search(r"\d+", type_)
if max_size is None:
raise ValueError("Max size could not be determinate. re.search() returned None")
raise ValueError(
"Max size could not be determinate. re.search() returned None"
)
return get_fstring(bytearray_, byte_index, int(max_size[0]))
elif type_.startswith("STRING"):
max_size = re.search(r"\d+", type_)
if max_size is None:
raise ValueError("Max size could not be determinate. re.search() returned None")
raise ValueError(
"Max size could not be determinate. re.search() returned None"
)
return get_string(bytearray_, byte_index)
elif type_.startswith("WSTRING"):
max_size = re.search(r"\d+", type_)
if max_size is None:
raise ValueError("Max size could not be determinate. re.search() returned None")
raise ValueError(
"Max size could not be determinate. re.search() returned None"
)
return get_wstring(bytearray_, byte_index)
else:
type_to_func: Dict[str, Callable[[bytearray, int], ValueType]] = {
Expand Down Expand Up @@ -629,7 +695,9 @@ def get_value(self, byte_index: Union[str, int], type_: str) -> ValueType:
return type_to_func[type_](bytearray_, byte_index)
raise ValueError

def set_value(self, byte_index: Union[str, int], type_: str, value: Union[bool, str, float]) -> Optional[bytearray]:
def set_value(
self, byte_index: Union[str, int], type_: str, value: Union[bool, str, float]
) -> Optional[bytearray]:
"""Sets the value for a specific type in the specified byte index.

Args:
Expand All @@ -649,14 +717,18 @@ def set_value(self, byte_index: Union[str, int], type_: str, value: Union[bool,

if type_ == "BOOL" and isinstance(value, bool):
byte_index, bool_index = str(byte_index).split(".")
return set_bool(bytearray_, self.get_offset(byte_index), int(bool_index), value)
return set_bool(
bytearray_, self.get_offset(byte_index), int(bool_index), value
)

byte_index = self.get_offset(byte_index)

if type_.startswith("FSTRING") and isinstance(value, str):
max_size = re.search(r"\d+", type_)
if max_size is None:
raise ValueError("Max size could not be determinate. re.search() returned None")
raise ValueError(
"Max size could not be determinate. re.search() returned None"
)
max_size_grouped = max_size.group(0)
max_size_int = int(max_size_grouped)
set_fstring(bytearray_, byte_index, value, max_size_int)
Expand All @@ -665,7 +737,9 @@ def set_value(self, byte_index: Union[str, int], type_: str, value: Union[bool,
if type_.startswith("STRING") and isinstance(value, str):
max_size = re.search(r"\d+", type_)
if max_size is None:
raise ValueError("Max size could not be determinate. re.search() returned None")
raise ValueError(
"Max size could not be determinate. re.search() returned None"
)
max_size_grouped = max_size.group(0)
max_size_int = int(max_size_grouped)
set_string(bytearray_, byte_index, value, max_size_int)
Expand Down Expand Up @@ -711,7 +785,9 @@ def write(self, client: Client) -> None:
:obj:`ValueError`: if the `row_size` is less than 0.
"""
if not isinstance(self._bytearray, DB):
raise TypeError(f"Value self._bytearray: {self._bytearray} is not from type DB.")
raise TypeError(
f"Value self._bytearray: {self._bytearray} is not from type DB."
)
if self.row_size < 0:
raise ValueError("row_size must be greater equal zero.")

Expand Down Expand Up @@ -741,7 +817,9 @@ def read(self, client: Client) -> None:
:obj:`ValueError`: if the `row_size` is less than 0.
"""
if not isinstance(self._bytearray, DB):
raise TypeError(f"Value self._bytearray:{self._bytearray} is not from type DB.")
raise TypeError(
f"Value self._bytearray:{self._bytearray} is not from type DB."
)
if self.row_size < 0:
raise ValueError("row_size must be greater equal zero.")
db_nr = self._bytearray.db_number
Expand Down
Loading