refac: python convention public/private methods

user_session_builder.py

@@ -41,8 +41,8 @@ class User:
 
         self.max_nb_res = 0
 
-    #@private
-    def is_new_session(self, date_now):
+    ######## Private methods ########
+    def __is_new_session(self, date_now):
         """Checks if a new session should be started according to the delimitation approach (see Zackay and Feitelson 2013)"""
 
         if self.delim_approach == 'arrival':
@@ -57,12 +57,11 @@ class User:
             think_time = date_now - self.max_finish_time
             return (think_time > self.delim_threshold)
 
-    def sessions_finished_at_time(self, t):
+    def __sessions_finished_at_time(self, t):
         """Return the list of session that were finished at time t"""
         return [s for s in self.sessions.values() if s.max_finish_time <= t]
 
-    #@private
-    def update_session_graph(self, date_now):
+    def __update_session_graph(self, date_now):
         """Add the dependencies for the active session"""
         active_session = self.sessions[self.active_session_id]
 
@@ -72,7 +71,7 @@ class User:
         if not self.dynamic_reduction:
             # For all sessions that were finished when the current session was
             # started, add a directed edge weighted by the thinking time
-            for finish_sess in self.sessions_finished_at_time(date_now):
+            for finish_sess in self.__sessions_finished_at_time(date_now):
                 think_time = date_now - finish_sess.max_finish_time  # >=0
 
                 active_session.preceding_sessions.append(finish_sess.id)
@@ -109,8 +108,7 @@ class User:
                                     sess.id,
                                     weight=think_time)
 
-    #@private
-    def create_new_session(self, date_now):
+    def __create_new_session(self, date_now):
         """Create a new active session and achive the old one"""
 
         if self.active_session_id > 0:
@@ -125,12 +123,11 @@ class User:
         new_session = Session(self.active_session_id, date_now)
         self.sessions[self.active_session_id] = new_session
 
-    #@private
-    def add_job_to_active_session(self, job):
+    def __add_job_to_active_session(self, job):
         active_sess = self.sessions[self.active_session_id]
         active_sess.add_job(job)
 
-    #@public
+    ######## Public methods ########
     def add_job(self, job):
         """Add a job to the job list of the user, creating a new session and 
         handling its dependencies, if needed."""
@@ -140,10 +137,10 @@ class User:
         date_now = job.submit_time
 
         # does the job start a new session?
-        if self.is_new_session(date_now):
-            self.create_new_session(date_now)
-            self.update_session_graph(date_now)
-        self.add_job_to_active_session(job)
+        if self.__is_new_session(date_now):
+            self.__create_new_session(date_now)
+            self.__update_session_graph(date_now)
+        self.__add_job_to_active_session(job)
 
         # Updating variables
         self.last_submit_time = job.submit_time