danny/satisfactory
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

satisfactory: Add docstrings for all Cookbook functions

Browse Source
This commit is contained in:
Danny Robson 2019-07-14 11:22:45 +10:00
parent 10a3438472
commit 5c4393b999
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
satisfactory/__init__.py
View File

@ -21,19 +21,40 @@ class Cookbook(object):
return self.__recipes[item]
def all(self) -> Iterable[str]:
"""
:return: An iterable of all available recipe names
"""
return self.__recipes.keys()
def recipes(self, name: str) -> Dict:
def recipes(self, name: str) -> Iterable[Dict]:
"""
:param name: The target item name
:return: A sequence of possible recipes for the target item
"""
return self.__recipes[name]['recipes']
def is_component(self, name: str) -> bool:
"""
:param name: The name of an item
:return: Whether the item is a component; ie, craftable.
"""
return 'component' in self.__recipes[name]['type']
def components(self) -> Generator[str, None, None]:
"""
:return: The names of all items that are resources.
"""
return (i for i in self.all() if self.is_component(i))
def is_resource(self, name: str) -> bool:
"""
:param name: The name of an item
:return: Whether the item must have harvested (rather than crafted)
"""
return 'resource' in self.__recipes[name]['type']
def resources(self) -> Generator[str, None, None]:
"""
:return: The names of all items that are resources.
"""
return (i for i in self.all() if self.is_resource(i))