From b72ae741c9141f35c6cfc97e12e441aeda2530cc Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Mon, 21 Jun 2021 11:16:15 -0400 Subject: [PATCH] Correct mis-spelled parse_eaders to parse_headers and added header only loading with args docs --- src/webqueue2api/parser/item.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/webqueue2api/parser/item.py b/src/webqueue2api/parser/item.py index a9daa4d..185b2b4 100644 --- a/src/webqueue2api/parser/item.py +++ b/src/webqueue2api/parser/item.py @@ -18,6 +18,11 @@ class Item: """A single issue. + Args: + queue (str): The name of the Item's queue. + number (int): The number of the Item. + headersOnly (bool, optional): Whether or not to parse headers only. Defaults to False. + Example: # Create an Item (ce100) `item = Item("ce", 100)` @@ -45,7 +50,7 @@ class Item: ItemDoesNotExistError: If an item does not exist on the filesystem. """ - def __init__(self, queue: str, number: int) -> None: + def __init__(self, queue: str, number: int, headers_only: bool = False) -> None: self.queue = queue try: @@ -59,8 +64,8 @@ def __init__(self, queue: str, number: int) -> None: self.last_updated = self.__get_time_last_updated() self.__raw_tem = self.__get_raw_item() - self.headers = self.__parse_eaders() - self.content = self.__parseSections() + self.headers = self.__parse_headers() + if not headers_only: self.content = self.__parseSections() self.is_locked = self.__check_is_locked() self.user_email = self.__parse_from_data(data="user_email") self.user_name = self.__parse_from_data(data="user_name") @@ -155,7 +160,7 @@ def __get_header_boundary(self) -> int: if line == "\n": return line_number - def __parse_eaders(self) -> list: + def __parse_headers(self) -> list: """Returns a list containing dictionaries of header type and data. Removes queue prefixes and whitespace.