Ajout de commentaires

million/analyze/find_holes.py

@@ -7,6 +7,10 @@ import million.analyze.message_evaluation as msg_val
 
 
 def compute_sequences(messages: List[Message], accepted_max: int = 1_000_000) -> List[Sequence]:
+    """ 
+    Takes a list of messages as input and returns a list of sequences
+    for every following messages with following 'counted values'
+    """
     sequences: List[Sequence] = [Sequence(start_message=messages[0])]
     
     for message in messages[1:]:
@@ -21,6 +25,10 @@ def compute_sequences(messages: List[Message], accepted_max: int = 1_000_000) ->
 
 
 def merge_duplicates(sequences: List[Sequence]) -> List[Sequence]:
+    """ 
+    Take sequences as an input and returns a list with every
+    overlapping input sequences merged in one
+    """
     o_sequences = sorted(sequences, key= lambda s : s.start())
     current = o_sequences[0]
 
@@ -38,6 +46,10 @@ def merge_duplicates(sequences: List[Sequence]) -> List[Sequence]:
 
 
 def invert_sequences(sequences: List[Sequence]) -> List[Sequence]:
+    """ 
+    Returns the sequences representing the spaces between
+    the ones given as input
+    """
     result = []
 
     for previous, current in zip(sequences[:-1],sequences[1:]):
@@ -51,6 +63,7 @@ def invert_sequences(sequences: List[Sequence]) -> List[Sequence]:
 def find_holes(messages: List[Message], accepted_max: int = 1_000_000) -> List[Sequence]:
     """
     Find the holes in the conversation
+    TODO might need to be moved inside scripts/find_holes
     """
     sequences = compute_sequences(messages, accepted_max)
     merged = merge_duplicates(sequences)

million/analyze/message_evaluation.py

@@ -21,6 +21,7 @@ def __compute__(msg: Message) -> int:
     return value
 
 def get(msg: Message) -> int:
-    """ Returns the estimated value counted in this message
+    """
+    Returns the estimated value counted in this message
     """
     return memoization.get(msg, __compute__(msg))

million/parse/fb_exports.py

@@ -6,16 +6,27 @@ from million.model.fb_export import FacebookExport
 
 
 def is_file_valid(file_name: str) -> bool:
+    """ 
+    Check if this file can be parsed into a FacebookExport
+    (Actually only check if its a json file atm)
+    """
     # NOTE is there a way to peek inside a json file to
     # check its internal structure ?
     return os.path.splitext(file_name)[-1].lower() == '.json'
 
 def valid_dirfiles(file_dir: str) -> List[str]:
+    """ 
+    Returns a list of parsable files contained
+    in this directory
+    """
     return [os.path.join(file_dir, file_name)
             for file_name in os.listdir(file_dir)
             if is_file_valid(file_name)]
 
 def parse_file(file_name: str) -> FacebookExport:
+    """ 
+    Parses a single parsable file into a FacebookExport Object
+    """
     if not is_file_valid(file_name): return None
 
     with open(file_name, 'rb') as f:
@@ -23,6 +34,10 @@ def parse_file(file_name: str) -> FacebookExport:
         return FacebookExport.model_validate_json(json_data)
 
 def parse_dirfiles(file_dir: str) -> FacebookExport:
+    """ 
+    Parses every parsable files inside this directory
+    into a single FacebookExport Object
+    """
     exports = [parse_file(f) for f in valid_dirfiles(file_dir)]
     
     result = exports[0]