from argparse import _SubParsersAction
from functools import partial
from typing import List
from lxml.objectify import IntElement, StringElement
from q2_sdk.core.dynamic_imports import (
api_ExecuteStoredProcedure as ExecuteStoredProcedure,
)
from .db_object import DbObject
from .representation_row_base import RepresentationRowBase
[docs]
class AdminTextElementRow(RepresentationRowBase):
# object name: type hinting = "column name in the db response"
TextElementID: IntElement = "TextElementID"
ShortName: StringElement = "ShortName"
Description: StringElement = "Description"
[docs]
class AdminTextElement(DbObject):
# GET_BY_NAME_KEY = "column in the db response"
NAME = "AdminTextElement"
REPRESENTATION_ROW_CLASS = AdminTextElementRow
[docs]
def add_arguments(self, parser: _SubParsersAction):
subparser = parser.add_parser("get_admin_text_element")
subparser.set_defaults(parser="get_by_short_name")
subparser.set_defaults(
func=partial(self.get_by_short_name, serialize_for_cli=True)
)
subparser.add_argument("shortname", help="admin.Q2_TextElement.ShortName")
[docs]
async def get_by_short_name(
self, shortname: str, serialize_for_cli=False
) -> List[AdminTextElementRow]:
response = await self.call_hq(
"sdk_GetAdminUiTextElementByShortName",
ExecuteStoredProcedure.SqlParameters([
ExecuteStoredProcedure.SqlParam(
ExecuteStoredProcedure.DataType.VarChar, "shortName", shortname
)
]),
)
if serialize_for_cli:
columns = ["TextElementID", "ShortName", "Description"]
response = self.serialize_for_cli(response, columns)
return response