LSST Applications  21.0.0+75b29a8a7f,21.0.0+e70536a077,21.0.0-1-ga51b5d4+62c747d40b,21.0.0-10-gbfb87ad6+3307648ee3,21.0.0-15-gedb9d5423+47cba9fc36,21.0.0-2-g103fe59+fdf0863a2a,21.0.0-2-g1367e85+d38a93257c,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g5242d73+d38a93257c,21.0.0-2-g7f82c8f+e682ffb718,21.0.0-2-g8dde007+d179fbfa6a,21.0.0-2-g8f08a60+9402881886,21.0.0-2-ga326454+e682ffb718,21.0.0-2-ga63a54e+08647d4b1b,21.0.0-2-gde069b7+26c92b3210,21.0.0-2-gecfae73+0445ed2f95,21.0.0-2-gfc62afb+d38a93257c,21.0.0-27-gbbd0d29+ae871e0f33,21.0.0-28-g5fc5e037+feb0e9397b,21.0.0-3-g21c7a62+f4b9c0ff5c,21.0.0-3-g357aad2+57b0bddf0b,21.0.0-3-g4be5c26+d38a93257c,21.0.0-3-g65f322c+3f454acf5d,21.0.0-3-g7d9da8d+75b29a8a7f,21.0.0-3-gaa929c8+9e4ef6332c,21.0.0-3-ge02ed75+4b120a55c4,21.0.0-4-g3300ddd+e70536a077,21.0.0-4-g591bb35+4b120a55c4,21.0.0-4-gc004bbf+4911b9cd27,21.0.0-4-gccdca77+f94adcd104,21.0.0-4-ge8fba5a+2b3a696ff9,21.0.0-5-gb155db7+2c5429117a,21.0.0-5-gdf36809+637e4641ee,21.0.0-6-g00874e7+c9fd7f7160,21.0.0-6-g4e60332+4b120a55c4,21.0.0-7-gc8ca178+40eb9cf840,21.0.0-8-gfbe0b4b+9e4ef6332c,21.0.0-9-g2fd488a+d83b7cd606,w.2021.05
LSST Data Management Base Package
Public Member Functions | List of all members
butler_cmd_test.ButlerCmdTestBase Class Reference
Inheritance diagram for butler_cmd_test.ButlerCmdTestBase:

Public Member Functions

def instrumentClassName (self)
 
def secondInstrumentClassName (self)
 
def instrument (self)
 
def instrumentName (self)
 
def test_cli (self)
 

Detailed Description

Base class for tests of butler command line interface subcommands.
Subclass from this, then `unittest.TestCase` to get a working test suite.

Definition at line 34 of file butler_cmd_test.py.

Member Function Documentation

◆ instrument()

def butler_cmd_test.ButlerCmdTestBase.instrument (   self)
The instrument class.

Definition at line 63 of file butler_cmd_test.py.

63  def instrument(self):
64  """The instrument class."""
65  return doImport(self.instrumentClassName)
66 

◆ instrumentClassName()

def butler_cmd_test.ButlerCmdTestBase.instrumentClassName (   self)
The fully qualified instrument class name.

Returns
-------
`str`
    The fully qualified instrument class name.

Definition at line 41 of file butler_cmd_test.py.

41  def instrumentClassName(self):
42  """The fully qualified instrument class name.
43 
44  Returns
45  -------
46  `str`
47  The fully qualified instrument class name.
48  """
49  pass
50 

◆ instrumentName()

def butler_cmd_test.ButlerCmdTestBase.instrumentName (   self)
The name of the instrument.

Returns
-------
`str`
    The name of the instrument.

Definition at line 68 of file butler_cmd_test.py.

68  def instrumentName(self):
69  """The name of the instrument.
70 
71  Returns
72  -------
73  `str`
74  The name of the instrument.
75  """
76  return self.instrument.getName()
77 
std::string const & getName() const noexcept
Return a filter's name.
Definition: Filter.h:78

◆ secondInstrumentClassName()

def butler_cmd_test.ButlerCmdTestBase.secondInstrumentClassName (   self)
Optional; if provided the register-instrument test will try to
register two instruments.

Returns
-------
`str` or `None`
    The fully qualified instrument class name.

Definition at line 52 of file butler_cmd_test.py.

52  def secondInstrumentClassName(self):
53  """Optional; if provided the register-instrument test will try to
54  register two instruments.
55 
56  Returns
57  -------
58  `str` or `None`
59  The fully qualified instrument class name.
60  """
61 

◆ test_cli()

def butler_cmd_test.ButlerCmdTestBase.test_cli (   self)

Definition at line 78 of file butler_cmd_test.py.

78  def test_cli(self):
79  runner = LogCliRunner()
80  with runner.isolated_filesystem():
81  result = runner.invoke(butler.cli, ["create", "here"])
82  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
83  registerInstrumentArgs = ["register-instrument", "here", self.instrumentClassName]
84  if self.secondInstrumentClassName is not None:
85  registerInstrumentArgs.append(self.secondInstrumentClassName)
86  result = runner.invoke(butler.cli, registerInstrumentArgs)
87  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")
88  result = runner.invoke(butler.cli, ["write-curated-calibrations",
89  "here",
90  self.instrumentName,
91  "--collection", "collection"])
92  self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}")

The documentation for this class was generated from the following file: