24314004353

Committed 12 Apr 2026 06:59PM UTC coverage: 88.889%. First build

Build # 24314004353

Build Type

Pull #98

github

Committed by

web-flow

Commit Message

Merge 924012907 into b766bdecc

Pull Request Pull Request #98: Update module_base.py

Coverage Stats

966 of 1092 new or added lines in 23 files covered. (88.46%)

1008 of 1134 relevant lines covered (88.89%)

4.44 hits per line

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

94.74

/src/ms_ovba/Models/Entities/module_base.py

import uuid
from ms_ovba_compression.ms_ovba import MsOvba
from ms_ovba.Models.Fields.doubleEncodedString import (
    DoubleEncodedString
)
from ms_ovba.Models.Fields.packed_data import PackedData
from ms_ovba.Models.Fields.idSizeField import IdSizeField
from typing import Literal, TypeAlias, TypeVar


T = TypeVar('T', bound='ModuleBase')


WorkspaceType: TypeAlias = (
    tuple[int, int, int, int, Literal['C', 'I', 'Z']] |
    None
)


class ModuleBase():
    def __init__(self: T, name: str) -> None:
        """
        Initialize the module record
        """
        self.modName = DoubleEncodedString([0x0019, 0x0047], name)
        self.streamName = DoubleEncodedString([0x001A, 0x0032], name)
        self.docString = DoubleEncodedString([0x001C, 0x0048], "")
        self.helpContext = IdSizeField(0x001E, 4, 0)
        self._cookie = IdSizeField(0x002C, 2, 0xFFFF)

        # self.readonly = SimpleRecord(0x001E, 4, helpContext)
        # self.private = SimpleRecord(0x001E, 4, helpContext)
        self._cache = b''
        self.workspace: WorkspaceType = None
        self.type = ''
        self.created = 0
        self.modified = 0
        self._fileSize = 0
        self._size = 0

        # GUIDs
        self._guids: list[uuid.UUID] = []

    @property
    def guids(self: T) -> list[uuid.UUID]:
        return self._guids

    @guids.setter
    def guids(self: T, guid: uuid.UUID | list[uuid.UUID]) -> None:
        if isinstance(guid, list):
            self._guids = guid
        else:
            self._guids = [guid]

    def add_guid(self: T, guid: uuid.UUID) -> None:
        """
        Append a guid to the list
        """
        self._guids += [guid]

    @property
    def cache(self: T) -> bytes:
        return self._cache

    @cache.setter
    def cache(self: T, cache: bytes) -> None:
        self._cache = cache

    @property
    def cookie(self: T) -> int:
        return self._cookie.value

    @cookie.setter
    def cookie(self: T, value: int) -> None:
        self._cookie = IdSizeField(0x002C, 2, value)

    @property
    def name(self: T) -> str:
        return self.modName.value

    @property
    def bin_path(self: T) -> str:
        return self._file_path + ".bin"

    def add_workspace(self: T, val1: int, val2: int,
                      val3: int, val4: int,
                      val5: Literal['C', 'I', 'Z']) -> None:
        self.workspace = (val1, val2, val3, val4, val5)

    def pack(self: T, endien: str, cp_name: str) -> bytes:
        """
        Pack the metadata for use in the dir stream.
        """
        typeid_value = 0x0022 if self.type == 'Document' else 0x0021
        type_id = PackedData("HI", typeid_value, 0)
        self.offsetRec = IdSizeField(0x0031, 4, len(self._cache))
        output = (self.modName.pack(endien, cp_name)
                  + self.streamName.pack(endien, cp_name)
                  + self.docString.pack(endien, cp_name)
                  + self.offsetRec.pack(endien)
                  + self.helpContext.pack(endien, cp_name)
                  + self._cookie.pack(endien)
                  + type_id.pack(endien))
        footer = PackedData("HI", 0x002B, 0)
        output += footer.pack(endien)
        return output

    def to_project_module_string(self: T) -> str:
        return self.type + "=" + self.modName.value

    def add_file(self: T, file_path: str) -> None:
        self._file_path = file_path

    def write_file(self: T) -> None:
        bin_f = open(self._file_path + ".bin", "wb")
        bin_f.write(self._cache)
        with open(self._file_path + ".new", mode="rb") as new_f:
            contents = new_f.read()
        ms_ovba = MsOvba()
        compressed = ms_ovba.compress(contents)
        bin_f.write(compressed)
        bin_f.close()

    def _attr(self: T, name: str, value: str) -> str:
        return 'Attribute VB_' + name + ' = ' + value + '\n'

1	import uuid	5✔
2	from ms_ovba_compression.ms_ovba import MsOvba	5✔
3	from ms_ovba.Models.Fields.doubleEncodedString import (	5✔
4	DoubleEncodedString
5	)
6	from ms_ovba.Models.Fields.packed_data import PackedData	5✔
7	from ms_ovba.Models.Fields.idSizeField import IdSizeField	5✔
8	from typing import Literal, TypeAlias, TypeVar	5✔
9
10
11	T = TypeVar('T', bound='ModuleBase')	5✔
12
13
14	WorkspaceType: TypeAlias = (	5✔
15	tuple[int, int, int, int, Literal['C', 'I', 'Z']] \|
16	None
17	)
18
19
20	class ModuleBase():	5✔
21	def __init__(self: T, name: str) -> None:	5✔
22	"""
23	Initialize the module record
24	"""
25	self.modName = DoubleEncodedString([0x0019, 0x0047], name)	5✔
26	self.streamName = DoubleEncodedString([0x001A, 0x0032], name)	5✔
27	self.docString = DoubleEncodedString([0x001C, 0x0048], "")	5✔
28	self.helpContext = IdSizeField(0x001E, 4, 0)	5✔
29	self._cookie = IdSizeField(0x002C, 2, 0xFFFF)	5✔
30
31	# self.readonly = SimpleRecord(0x001E, 4, helpContext)
32	# self.private = SimpleRecord(0x001E, 4, helpContext)
33	self._cache = b''	5✔
34	self.workspace: WorkspaceType = None	5✔
35	self.type = ''	5✔
36	self.created = 0	5✔
37	self.modified = 0	5✔
38	self._fileSize = 0	5✔
39	self._size = 0	5✔
40
41	# GUIDs
42	self._guids: list[uuid.UUID] = []	5✔
43
44	@property	5✔
45	def guids(self: T) -> list[uuid.UUID]:	5✔
NEW 46	return self._guids	×
47
48	@guids.setter	5✔
49	def guids(self: T, guid: uuid.UUID \| list[uuid.UUID]) -> None:	5✔
NEW 50	if isinstance(guid, list):	×
NEW 51	self._guids = guid	×
52	else:
NEW 53	self._guids = [guid]	×
54
55	def add_guid(self: T, guid: uuid.UUID) -> None:	5✔
56	"""
57	Append a guid to the list
58	"""
59	self._guids += [guid]	5✔
60
61	@property	5✔
62	def cache(self: T) -> bytes:	5✔
63	return self._cache	5✔
64
65	@cache.setter	5✔
66	def cache(self: T, cache: bytes) -> None:	5✔
67	self._cache = cache	5✔
68
69	@property	5✔
70	def cookie(self: T) -> int:	5✔
71	return self._cookie.value	5✔
72
73	@cookie.setter	5✔
74	def cookie(self: T, value: int) -> None:	5✔
75	self._cookie = IdSizeField(0x002C, 2, value)	5✔
76
77	@property	5✔
78	def name(self: T) -> str:	5✔
79	return self.modName.value	5✔
80
81	@property	5✔
82	def bin_path(self: T) -> str:	5✔
83	return self._file_path + ".bin"	5✔
84
85	def add_workspace(self: T, val1: int, val2: int,	5✔
86	val3: int, val4: int,
87	val5: Literal['C', 'I', 'Z']) -> None:
88	self.workspace = (val1, val2, val3, val4, val5)	5✔
89
90	def pack(self: T, endien: str, cp_name: str) -> bytes:	5✔
91	"""
92	Pack the metadata for use in the dir stream.
93	"""
94	typeid_value = 0x0022 if self.type == 'Document' else 0x0021	5✔
95	type_id = PackedData("HI", typeid_value, 0)	5✔
96	self.offsetRec = IdSizeField(0x0031, 4, len(self._cache))	5✔
97	output = (self.modName.pack(endien, cp_name)	5✔
98	+ self.streamName.pack(endien, cp_name)
99	+ self.docString.pack(endien, cp_name)
100	+ self.offsetRec.pack(endien)
101	+ self.helpContext.pack(endien, cp_name)
102	+ self._cookie.pack(endien)
103	+ type_id.pack(endien))
104	footer = PackedData("HI", 0x002B, 0)	5✔
105	output += footer.pack(endien)	5✔
106	return output	5✔
107
108	def to_project_module_string(self: T) -> str:	5✔
109	return self.type + "=" + self.modName.value	5✔
110
111	def add_file(self: T, file_path: str) -> None:	5✔
112	self._file_path = file_path	5✔
113
114	def write_file(self: T) -> None:	5✔
115	bin_f = open(self._file_path + ".bin", "wb")	5✔
116	bin_f.write(self._cache)	5✔
117	with open(self._file_path + ".new", mode="rb") as new_f:	5✔
118	contents = new_f.read()	5✔
119	ms_ovba = MsOvba()	5✔
120	compressed = ms_ovba.compress(contents)	5✔
121	bin_f.write(compressed)	5✔
122	bin_f.close()	5✔
123
124	def _attr(self: T, name: str, value: str) -> str:	5✔
125	return 'Attribute VB_' + name + ' = ' + value + '\n'	5✔

Beakerboy / MS-OVBA / 24314004353

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