Relax source design - Revision history

Bugman: Added the Category:Infobox templates category.

2015-11-06T17:10:27Z

Added the Category:Infobox templates category.

Bugman: Using the {{lowercase title}} template.

2015-10-19T16:22:06Z

Using the {{lowercase title}} template.

Bugman: Added the {{stub}} template at the start.

2015-10-15T20:10:24Z

Added the {{stub}} template at the start.

Bugman: /* Implementation */ Fix for the code example.

2014-09-26T13:37:40Z

Implementation: Fix for the code example.

Bugman: /* Design */ Small edit.

2014-09-26T13:32:19Z

Design: Small edit.

Bugman: Undo revision 4249 by Bugman (talk) - This can be simpler without the self arg!

2014-09-26T13:16:05Z

Undo revision 4249 by Bugman (talk) - This can be simpler without the self arg!

Bugman: /* Implementation */ Forgot the 'self' argument.

2014-09-26T13:12:17Z

Implementation: Forgot the 'self' argument.

Bugman: /* The check_() functions / More changes to the check_*() function design.

2014-09-26T13:11:14Z

The check_*() functions: More changes to the check_*() function design.

Bugman: /* The check_() functions / Renaming.

2014-09-26T10:12:20Z

The check_*() functions: Renaming.

Bugman: /* The check_() functions / Expanded the implementation section.

2014-09-26T10:10:29Z

The check_*() functions: Expanded the implementation section.

← Older revision		Revision as of 17:10, 6 November 2015
Line 103:		Line 103:

	Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_aaa_func' function as arguments. The escalate argument defaults to 2.		Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_aaa_func' function as arguments. The escalate argument defaults to 2.
		+
		+	== See also ==
		+
		+	[[Category:Development]]

← Older revision		Revision as of 16:22, 19 October 2015
Line 1:		Line 1:
		+	{{lowercase title}}
		+
	{{stub}}		{{stub}}

← Older revision		Revision as of 20:10, 15 October 2015
Line 1:		Line 1:
		+	{{stub}}
		+
	The following is a set of notes which will be used to design the layout of functions, modules, and packages in relax.		The following is a set of notes which will be used to design the layout of functions, modules, and packages in relax.

← Older revision		Revision as of 13:37, 26 September 2014
Line 60:		Line 60:


−	def check_aaa_func(a=None):	+	def check_aaa_func(a, b=None):
	"""Check if aaa.		"""Check if aaa.

@@ Line 41: / Line 41: @@
 === Design ===
-The check_*() functions, via the Check object, accept the 'escalate' keyword argument which can have the following values:
+The check_*() functions, via the Check object __call__() method, accept the 'escalate' keyword argument which can have the following values:
 * 0 - This will simply cause the function to return True or False.

← Older revision		Revision as of 13:16, 26 September 2014
Line 60:		Line 60:


−	def check_aaa_func(~~self,~~ a=None):	+	def check_aaa_func(a=None):
	"""Check if aaa.		"""Check if aaa.

← Older revision		Revision as of 13:12, 26 September 2014
Line 60:		Line 60:


−	def check_aaa_func(a=None):	+	def check_aaa_func(self, a=None):
	"""Check if aaa.		"""Check if aaa.

@@ Line 30: / Line 30: @@
 == The check_*() functions ==
-These functions are for performing checks for certain data being present.  The idea uses the [https://en.wikipedia.org/wiki/Strategy_pattern strategy design pattern] which is implemented in the lib.checks.Check class.
+These functions are for performing checks for certain data being present.  The idea uses the [https://en.wikipedia.org/wiki/Strategy_pattern strategy design pattern] which is implemented in the lib.checks.Check class.  Therefore these are really function-like objects.
 === Packages ===
@@ Line 46: / Line 46: @@
 * 1 - In addition to returning True or False, the function will throw a RelaxWarning for better user feedback.
 * 2 - This will cause a RelaxError to be raised if the data is missing, not set up, etc.  Otherwise the function returns True.
 === Implementation ===
@@ Line 55: / Line 57: @@
 # relax module imports.
 from lib.checks import Check
@@ Line 64: / Line 67: @@
      @keyword b:     Some check specific keyword argument.
      @type b:        int
-     @return:        The status of the check and the message to send to the user.
+     @return:        The initialised RelaxError object or nothing.
-     @rtype:         bool, str
+     @rtype:         None or RelaxError instance
      """
      # Check that...
      if not something(a, b):
-         check_ok = False
+         return RelaxError("Some text")
 # Create the checking object.
@@ Line 97: / Line 94: @@
      a = '600 MHz'
      b = 600
-     check_aaa(a, b=b, escalate=2)
+     check_aaa(a, b=b)
 </source>
-Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_aaa_func' function as arguments.
+Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_aaa_func' function as arguments.  The escalate argument defaults to 2.

@@ Line 57: / Line 57: @@
-def check_xxx_func(a=None):
+def check_aaa_func(a=None):
-     """Check if xxx.
+     """Check if aaa.
      @param a:       Some check specific argument.
@@ Line 79: / Line 79: @@
 # Create the checking object.
-check_xxx = Check(check_xxx_func)
+check_aaa = Check(check_aaa_func)
 </source>
@@ Line 88: / Line 88: @@
 # relax module imports.
-from xxx import check_xxx
+from aaa import check_aaa
-def aaa():
+def bbb():
      """Some function."""
@@ Line 97: / Line 97: @@
      a = '600 MHz'
      b = 600
-     check_xxx(a, b=b, escalate=2)
+     check_aaa(a, b=b, escalate=2)
 </source>
-Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_xxx_func' function as arguments.
+Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_aaa_func' function as arguments.

@@ Line 49: / Line 49: @@
 === Implementation ===
-Here is a prototype function:
+Here is a prototype for implementing the check object:
 <source lang="python">
@@ Line 60: / Line 60: @@
      """Check if xxx.
-     @keyword a:     Some check specific keyword argument.
+    @param a:       Some check specific argument.
-     @type a:        int
+    @type a:        str
      @return:        The status of the check and the message to send to the user.
      @rtype:         bool, str
@@ Line 70: / Line 72: @@
      # Check that...
-     if not something(a):
+     if not something(a, b):
          check_ok = False
@@ Line 80: / Line 82: @@
 </source>