CallDepthMixin

class PlasmaCalcs.quantities.quantity_tools.CallDepthMixin

Bases: object

Mixin class for tracking call depth.

call depth == number of times self has been called inside other calls to self.

see help(type(self).call_depth) for details.

subclasses should include “with self._increment_call_depth():” inside of __call__, e.g.:

def __call__(self, *args, **kw):

with self._increment_call_depth():

# do stuff; possibly including calling self again.

Methods

using_at_call_depth(depth, **attrs_and_values)	context manager for setting attrs_and_values but only while call_depth == depth.
using_at_next_call_depth(**attrs_and_values)	context manager for setting attrs_and_values but only while call_depth == self.call_depth + 1
_increment_call_depth()	context manager for incrementing call_depth.

Attributes

call_depth	depth of the current call to self.
call_depth_manager	stores the value of call_depth, and helps to manage attrs dependent on call_depth value.

_increment_call_depth()

context manager for incrementing call_depth.

use “with self._increment_call_depth():” inside of __call__, e.g.:

def __call__(self, *args, **kw):

with self._increment_call_depth():

# do stuff; possibly including calling self again.

Equivalent to self.call_depth_manager.increment()

property call_depth

depth of the current call to self. depth = number of calls to self from within self.

E.g., call_depth while calculating gyrofrequency:

# call_depth == 0, for any code run here (outside any call to self).

self(‘gyrof’)

# call_depth == 1, for any code run here (inside ‘gyrof’ call but not inside deeper calls).

q = self(‘q’)

# call_depth == 2, for code inside ‘q’ call.

mod_B = self(‘mod_B’)

# call_depth == 2, for code inside ‘mod_B’ call.

self(‘B’)

# call_depth == 3, for code inside ‘B’ call.

m = self(‘m’)

# call_depth == 2, for code inside ‘m’ call.

result = q * mod_B / m

Cannot be set directly; can only be manipulated via self.call_depth_manager.

property call_depth_manager

stores the value of call_depth, and helps to manage attrs dependent on call_depth value.

using_at_call_depth(depth, **attrs_and_values)

context manager for setting attrs_and_values but only while call_depth == depth.

E.g.:

with self.using_at_call_depth(3, verbose=3):

self(‘sgyrof’)

# while self.call_depth == 3 inside of this ‘with’ block, uses self.verbose=3.

# but everywhere else, uses original value of verbose.

# assuming originally verbose=False (or unset), this example will print:

| | (call_depth=2) get var=’q’

| | (call_depth=2) get var=’mod_B’

| | (call_depth=2) get var=’m’

# compare this to simply using self.verbose=3, which would print:

| (call_depth=1) get var=’sgyrof’

| | (call_depth=2) get var=’q’

| | (call_depth=2) get var=’mod_B’

| | | (call_depth=3) get var=’B_dot_B’

| | | | (call_depth=4) get var=’B_xyz’

| | | | | (call_depth=5) get var=’B’

| | (call_depth=2) get var=’m’

Equivalent to self.call_depth_manager.using_obj_attrs_at(depth, **attrs_and_values)

using_at_next_call_depth(**attrs_and_values)

context manager for setting attrs_and_values but only while call_depth == self.call_depth + 1

Equivalent to self.using_at_call_depth(self.call_depth + 1, **attrs_and_values).

(Also equivalent to self.call_depth_manager.using_obj_attrs_at_next(**attrs_and_values).)