diff --git a/src/webqueue2api/parser/queue.py b/src/webqueue2api/parser/queue.py index e128932..d9df107 100644 --- a/src/webqueue2api/parser/queue.py +++ b/src/webqueue2api/parser/queue.py @@ -51,7 +51,7 @@ def get_items(self) -> list: isFile = True if os.path.isfile(item_path) else False - if isFile and isValidItemName(item): + if isFile and is_valid_item_name(item): items.append(Item(self.name, item)) return items @@ -83,12 +83,12 @@ def __repr__(self) -> str: #------------------------------------------------------------------------------# # Utilities #------------------------------------------------------------------------------# -def isValidItemName(name: str) -> bool: +def is_valid_item_name(name: str) -> bool: """Returns true if file name is a valid item name Example: - isValidItemName("21") -> true - isValidItemName("twentyone") -> false + is_valid_item_name("21") -> true + is_valid_item_name("twentyone") -> false Args: name (str): The name to test. @@ -99,7 +99,7 @@ def isValidItemName(name: str) -> bool: itemPattern = re.compile("^[0123456789]{1,3}$") return True if itemPattern.match(name) else False -def getValidQueues() -> list: +def get_valid_queues() -> list: """Returns a list of queues on the filesystem excluding ignored queues. Example: @@ -111,16 +111,16 @@ def getValidQueues() -> list: queues = [] for file in os.listdir(config.queue_directory): - currentFile = config.queue_directory + "/" + file - isDirectory = os.path.isdir(currentFile) - isValid = file not in config.queues_to_ignore + current_file = config.queue_directory + "/" + file + is_directory = os.path.isdir(current_file) + is_valid = file not in config.queues_to_ignore - if isDirectory and isValid: + if is_directory and is_valid: queues.append(file) return queues -def getQueueCounts() -> list: +def get_queue_counts() -> list: """Returns a list of dictionaries with the number of items in each queue. Example: @@ -138,18 +138,18 @@ def getQueueCounts() -> list: Returns: list: Dictionaries with the number of items in each queue. """ - queueInfo = [] - for queue in getValidQueues(): - possibleItems = os.listdir(config.queue_directory + "/" + queue) - validItems = [isValidItemName for file in possibleItems] - queueInfo.append( {"name": queue, "number_of_items": len(validItems)} ) + queue_info = [] + for queue in get_valid_queues(): + possible_items = os.listdir(config.queue_directory + "/" + queue) + valid_items = [is_valid_item_name for file in possible_items] + queue_info.append( {"name": queue, "number_of_items": len(valid_items)} ) # Sorts list of queue info alphabetically - sortedQueueInfo = sorted(queueInfo, key = lambda queueInfoList: queueInfoList['name']) + sorted_queue_info = sorted(queue_info, key = lambda queue_info_list: queue_info_list['name']) - return sortedQueueInfo + return sorted_queue_info -def loadQueues() -> list: +def load_queues() -> list: """Return a list of Queues for each queue. Returns: @@ -157,7 +157,7 @@ def loadQueues() -> list: """ queues = [] - for queue in getValidQueues(): + for queue in get_valid_queues(): queues.append(Queue(queue)) return queues \ No newline at end of file