CuneiModel - ประวัติรุ่นแก้ไข

Tenko: /* Cross-table references */

2024-12-07T04:24:00Z

Cross-table references

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 11:24, 7 ธันวาคม 2567
บรรทัดที่ 93:		บรรทัดที่ 93:
	</syntaxhighlight>		</syntaxhighlight>

	In this example, the static ID of our sales representative (stored as {{code\|Customer.~~cores_stid~~}}) is referencing the Employee table at {{code\|Employee.stid}}. Although the code and name of the representative '''DO NOT''' actually appear in the Customer table itself, one can access these value via {{code\|Customer.corres_code}} and {{code\|Customer.corres_name}} respectively.		In this example, the static ID of our sales representative (stored as {{code\|Customer.corres_stid}}) is referencing the Employee table at {{code\|Employee.stid}}. Although the code and name of the representative '''DO NOT''' actually appear in the Customer table itself, one can access these value via {{code\|Customer.corres_code}} and {{code\|Customer.corres_name}} respectively.

	Do note that in self-referencing (in this case, a customer's parent company which is yet another customer), the CuneiModel specification is simply a string {{code\|lang=python\|'self'}}.		Do note that in self-referencing (in this case, a customer's parent company which is yet another customer), the CuneiModel specification is simply a string {{code\|lang=python\|'self'}}.

Tenko เมื่อ 22:13, 5 เมษายน 2567

2024-04-05T22:13:08Z

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 05:13, 6 เมษายน 2567
บรรทัดที่ 153:		บรรทัดที่ 153:
	\| '''Returns''' \|\| '''None'''. Referenced values are attributed to the input object(s) directly.		\| '''Returns''' \|\| '''None'''. Referenced values are attributed to the input object(s) directly.
	\|}		\|}


			{{The Tenko Shrine}}

Tenko: /* Common Functions */

2024-04-05T05:16:37Z

Common Functions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 12:16, 5 เมษายน 2567
บรรทัดที่ 129:		บรรทัดที่ 129:
	=== perm_m2d ===		=== perm_m2d ===
	This is the shortcut for {{code\|m2d}} intended for use with Permission-type Object.		This is the shortcut for {{code\|m2d}} intended for use with Permission-type Object.

			=== extract_crossers ===
			This function is a class method. It extracts a list of mock_fields from the CuneiModel's CROSS_TBS specification. On itself, it is not exactly useful. However, it is used almost exclusively to determine the necessity of performing the referencing in the first place; for example, if the current table to display the entries does not show any of the mock_fields, then the refencing can be skipped.

			'''{{code\|lang=python\|extract_crossers(cl)}}'''

			{\| style="margin-left:20px;"
			\|- style="vertical-align:top;"
			\| style="width:120px;" \| '''Parameters''' \|\| -
			\|- style="vertical-align:top;"
			\| '''Returns''' \|\| A '''list''' of mock_field names.
			\|}

			=== get_crossers ===

			'''{{code\|lang=python\|get_crossers(cl, objs)}}'''

			{\| style="margin-left:20px;"
			\|- style="vertical-align:top;"
			\| style="width:120px;" \| '''Parameters''' \|\|
			* '''objs''' ''(list of Model instances OR a Model instance)'': Object(s) to perform referencing on.
			\|- style="vertical-align:top;"
			\| '''Returns''' \|\| '''None'''. Referenced values are attributed to the input object(s) directly.
			\|}

Tenko: /* Cross-table references */

2024-04-05T04:42:48Z

Cross-table references

@@ บรรทัดที่ 53: / บรรทัดที่ 53: @@
                  ...
+             ]
 </syntaxhighlight>
 Let's take an example from the CuneiModel for customer:
@@ บรรทัดที่ 77: / บรรทัดที่ 74: @@
      corres_stid = IntegerField(default=0)
      ...
-     CROSS_TBS = [("acccode", AccCode, [[["stid", "acccode_stid"], {"code":"acccode_code", "name":"acccode_name"}]]),
+     CROSS_TBS = [("acccode", AccCode, [[["stid", "acccode_stid"],
                  ("customer", "self", [[["stid", "main_stid"], {"code":"main_code", "name":"main_name"}]]),
-                 ("employee", Employee, [[["stid", "corres_stid"], {"code":"corres_code", "name":"corres_name"}]])]
+                                                "code":"acccode_code",
      class Meta:
          database = SqliteExtDatabase(None)

Tenko: /* Cross-table references */

2024-04-05T04:35:22Z

Cross-table references

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 11:35, 5 เมษายน 2567
บรรทัดที่ 19:		บรรทัดที่ 19:
	<syntaxhighlight lang="python" line="1">		<syntaxhighlight lang="python" line="1">
	CROSS_TBS = [		CROSS_TBS = [
	(str ~~db_name0~~, CuneiModel ~~model0~~,		(str ref_db_name0, CuneiModel ref_model0,
	[		[
	[[str ref_field000, str this_model_field000], {str ref_field001:str mock_field001, str ref_field002: str mock_field002, ...}],		[[str ref_field000, str this_model_field000],
	[[str ref_field010, str this_model_field010], {str ref_field011:str mock_field011, str ref_field012: str mock_field012, ...}],		{
			str ref_field001: str mock_field001,
			str ref_field002: str mock_field002,
			...
			}],
			[[str ref_field010, str this_model_field010],
			{
			str ref_field011: str mock_field011,
			str ref_field012: str mock_field012,
			...
			}],
	...		...
	]),		]),
	(str ~~db_name1~~, CuneiModel ~~model1~~,		(str ref_db_name1, CuneiModel ref_model1,
	[		[
	[[str ref_field100, str this_model_field100], {str ref_field101:str mock_field101, str ref_field102: str mock_field102, ...}],		[[str ref_field100, str this_model_field100],
	[[str ref_field110, str this_model_field110], {str ref_field111:str mock_field111, str ref_field112: str mock_field112, ...}],		{
			str ref_field101: str mock_field101,
			str ref_field102: str mock_field102,
			...
			}],
			[[str ref_field110, str this_model_field110],
			{
			str ref_field111: str mock_field111,
			str ref_field112: str mock_field112,
			...
			}],
	...		...
	]),		]),
	...		...
	]		]

			# ref_db_nameX: the name of the referenced database file.
			# ref_modelX: the model associated with a table within said database X.
			# ref_fieldXYZ: the field name actually present in the referenced table X.
			# this_model_fieldXYZ: the field name actually present in the current model
			# that is associated with the value in ref_fieldXYZ.
			# mock_fieldXYZ: a field name not actually present in the current model, but
			# will take on the value of ref_fieldXYZ once referencing is made.
	</syntaxhighlight>		</syntaxhighlight>

	Let's take an example from the CuneiModel for customer:		Let's take an example from the CuneiModel for customer:

	<syntaxhighlight lang="python" line="1">		<syntaxhighlight lang="python" line="1">
บรรทัดที่ 46:		บรรทัดที่ 74:
	main_stid = IntegerField()		main_stid = IntegerField()
	acccode_stid = IntegerField(default=0)		acccode_stid = IntegerField(default=0)
	~~...~~
	~~address = TextField(default="")~~
	~~zip = CharField(default="")~~
	...		...
	corres_stid = IntegerField(default=0)		corres_stid = IntegerField(default=0)
	~~taxform_stid = IntegerField(default=0)~~
	~~whtdesc_stid = IntegerField(default=0)~~
	~~whtdesc_desc = CharField(default="")~~
	...		...
	CROSS_TBS = [("acccode", AccCode, [[["stid", "acccode_stid"], {"code":"acccode_code", "name":"acccode_name"}]]),		CROSS_TBS = [("acccode", AccCode, [[["stid", "acccode_stid"], {"code":"acccode_code", "name":"acccode_name"}]]),
	("customer", "self", [[["stid", "main_stid"], {"code":"main_code", "name":"main_name"}]]),		("customer", "self", [[["stid", "main_stid"], {"code":"main_code", "name":"main_name"}]]),
	("employee", Employee, [[["stid", "corres_stid"], {"code":"corres_code", "name":"corres_name~~"}]]),~~		("employee", Employee, [[["stid", "corres_stid"], {"code":"corres_code", "name":"corres_name"}]])]
	~~("whttype", WhtType, [[["stid", "taxform_stid"], {"code":"taxform_code", "name":"taxform_name"}]]),~~
	~~("whtdesc", WhtDesc, [[["stid", "whtdesc_stid"], {"code":"whtdesc_code", "taxrate":"rate~~"}]])]
	class Meta:		class Meta:
	database = SqliteExtDatabase(None)		database = SqliteExtDatabase(None)
	</syntaxhighlight>		</syntaxhighlight>

			In this example, the static ID of our sales representative (stored as {{code\|Customer.cores_stid}}) is referencing the Employee table at {{code\|Employee.stid}}. Although the code and name of the representative '''DO NOT''' actually appear in the Customer table itself, one can access these value via {{code\|Customer.corres_code}} and {{code\|Customer.corres_name}} respectively.

			Do note that in self-referencing (in this case, a customer's parent company which is yet another customer), the CuneiModel specification is simply a string {{code\|lang=python\|'self'}}.

	== Common Functions ==		== Common Functions ==

Tenko เมื่อ 04:15, 5 เมษายน 2567

2024-04-05T04:15:26Z

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 11:15, 5 เมษายน 2567
บรรทัดที่ 1:		บรรทัดที่ 1:
			The main reason for the existence of CuneiModel class, frankly, is to redirect the Metadata class from the Peewee native Metadata to CuneiFox's own ThreadSafeMetadata. However, since the opportunity presented itself, a few additional functions were also written for the class as well.

			== Define ==
			Defining a CuneiModel is essentially similar to declaring a normal Peewee Model. Do refer to [https://docs.peewee-orm.com/en/latest/peewee/models.html the official documentation]. Below is the CuneiModel for product unit as an example:

			<syntaxhighlight lang="python" line="1">
			class Unit(CuneiModel):
			id = AutoIncrementField()
			stid = IntegerField(unique=True)
			code = CharField(unique=True)
			name = CharField(default="")
			class Meta:
			database = SqliteExtDatabase(None)
			</syntaxhighlight>

			=== Cross-table references ===
			CuneiFox is designed in a way that all tables do not necessarily reside in the same database file. Thus, cross-table references require a little more work. The specifications for cross-table references are set in the variable {{code\|CROSS_TBS}} in this format:

			<syntaxhighlight lang="python" line="1">
			CROSS_TBS = [
			(str db_name0, CuneiModel model0,
			[
			[[str ref_field000, str this_model_field000], {str ref_field001:str mock_field001, str ref_field002: str mock_field002, ...}],
			[[str ref_field010, str this_model_field010], {str ref_field011:str mock_field011, str ref_field012: str mock_field012, ...}],
			...
			]),
			(str db_name1, CuneiModel model1,
			[
			[[str ref_field100, str this_model_field100], {str ref_field101:str mock_field101, str ref_field102: str mock_field102, ...}],
			[[str ref_field110, str this_model_field110], {str ref_field111:str mock_field111, str ref_field112: str mock_field112, ...}],
			...
			]),
			...
			]
			</syntaxhighlight>

			Let's take an example from the CuneiModel for customer:

			<syntaxhighlight lang="python" line="1">
			class Customer(CuneiModel):
			id = AutoIncrementField()
			stid = IntegerField(unique=True)
			code = CharField(unique=True)
			name = CharField(default="")
			is_sub = BooleanField(default=False)
			main_stid = IntegerField()
			acccode_stid = IntegerField(default=0)
			...
			address = TextField(default="")
			zip = CharField(default="")
			...
			corres_stid = IntegerField(default=0)
			taxform_stid = IntegerField(default=0)
			whtdesc_stid = IntegerField(default=0)
			whtdesc_desc = CharField(default="")
			...
			CROSS_TBS = [("acccode", AccCode, [[["stid", "acccode_stid"], {"code":"acccode_code", "name":"acccode_name"}]]),
			("customer", "self", [[["stid", "main_stid"], {"code":"main_code", "name":"main_name"}]]),
			("employee", Employee, [[["stid", "corres_stid"], {"code":"corres_code", "name":"corres_name"}]]),
			("whttype", WhtType, [[["stid", "taxform_stid"], {"code":"taxform_code", "name":"taxform_name"}]]),
			("whtdesc", WhtDesc, [[["stid", "whtdesc_stid"], {"code":"whtdesc_code", "taxrate":"rate"}]])]
			class Meta:
			database = SqliteExtDatabase(None)
			</syntaxhighlight>

	== Common Functions ==		== Common Functions ==

			=== printout ===
			Peewee normal printout representatin of a Model object is only its ID. This behaviour is not useful in a lot of cases; hence, this function.

			'''{{code\|lang=python\|printout(self)}}'''
			{\| style="margin-left:20px;"
			\|- style="vertical-align:top;"
			\| style="width:120px;" \| '''Parameters''' \|\| -
			\|- style="vertical-align:top;"
			\| '''Returns''' \|\| A '''string''' showing the CuneiModel name and the content of the entry in a dict format.
			\|}

			=== m2d ===
			This function is an easy way to convert an entry from a Peewee object form to a dict form.

			'''{{code\|lang=python\|1= m2d(self, int_key=[], custom_keys=[])}}'''

			{\| style="margin-left:20px;"
			\|- style="vertical-align:top;"
			\| style="width:120px;" \| '''Parameters''' \|\|
			* '''int_key''' ''(list of strings)'': Field names which only integer representation is required. Intended for use with ForeignKeyFields.
			* '''custom_keys''' ''(list of strings)'': Field names to also include in the dict. ''See notes.''
			</p>
			\|- style="vertical-align:top;"
			\| '''Returns''' \|\| A '''dict''' representation of the fed object.
			\|- style="vertical-align:top;"
			\| '''Notes''' \|\| Without {{code\|custom_keys}} given, the returned dict only contains fields defined in the CuneiModel. Use {{code\|custom_keys}}, in cases where the object has been modified with added keys and such keys are also needed to be represented in the returned dict.
			\|}

			=== perm_m2d ===
			This is the shortcut for {{code\|m2d}} intended for use with Permission-type Object.

Tenko: สร้างหน้าด้วย "== Common Functions =="

2024-04-04T05:20:39Z

สร้างหน้าด้วย "== Common Functions =="

หน้าใหม่

== Common Functions ==