relocate tracing module and logfile path injection in logging.yaml

activitysim/defaults/__init__.py

@@ -1,7 +1,7 @@
 # ActivitySim
 # See full license in LICENSE.txt.
 
-import trace
+import tracing
 import misc
 import tables
 import models

activitysim/defaults/misc.py

@@ -28,6 +28,11 @@ def data_dir():
     return '.'
 
 
+@orca.injectable()
+def output_dir():
+    return '.'
+
+
 @orca.injectable()
 def settings(configs_dir):
     with open(os.path.join(configs_dir, "configs", "settings.yaml")) as f:

activitysim/defaults/models/auto_ownership.py

@@ -5,7 +5,7 @@
 import orca
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from .util.misc import add_dependent_columns
 
 
@@ -26,7 +26,7 @@ def auto_ownership_simulate(set_random_seed, households_merged,
     choices, _ = asim.simple_simulate(
         households_merged.to_frame(), auto_ownership_spec)
 
-    trace.print_summary('auto_ownership', choices, value_counts=True)
+    tracing.print_summary('auto_ownership', choices, value_counts=True)
 
     orca.add_column("households", "auto_ownership", choices)
 

activitysim/defaults/models/cdap.py

@@ -7,7 +7,7 @@
 import pandas as pd
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from activitysim.cdap import cdap
 
 
@@ -67,6 +67,6 @@ def cdap_simulate(set_random_seed, persons_merged,
 
     choices = choices.reindex(persons_merged.index)
 
-    trace.print_summary('cdap_activity', choices, value_counts=True)
+    tracing.print_summary('cdap_activity', choices, value_counts=True)
 
     orca.add_column("persons", "cdap_activity", choices)

activitysim/defaults/models/destination.py

@@ -9,7 +9,7 @@
 import numpy as np
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 
 logger = logging.getLogger(__name__)
 
@@ -78,7 +78,7 @@ def destination_choice(set_random_seed,
         logger.error("destination_choice had %s null destinations" % choices.isnull().sum())
         assert choices.isnull().sum() == 0
 
-    trace.print_summary('destination', choices, describe=True)
+    tracing.print_summary('destination', choices, describe=True)
 
     # every trip now has a destination which is the index from the
     # alternatives table - in this case it's the destination taz

activitysim/defaults/models/mandatory_scheduling.py

@@ -8,7 +8,7 @@
 import pandas as pd
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from .util.vectorize_tour_scheduling import vectorize_tour_scheduling
 
 
@@ -77,8 +77,8 @@ def mandatory_scheduling(set_random_seed,
 
     choices = pd.concat([school_choices, work_choices])
 
-    trace.print_summary('mandatory_scheduling tour_departure_and_duration',
-                        choices, describe=True)
+    tracing.print_summary('mandatory_scheduling tour_departure_and_duration',
+                          choices, describe=True)
 
     orca.add_column(
         "mandatory_tours", "tour_departure_and_duration", choices)

activitysim/defaults/models/mandatory_tour_frequency.py

@@ -8,7 +8,7 @@
 import pandas as pd
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from .util.mandatory_tour_frequency import process_mandatory_tours
 
 
@@ -45,7 +45,7 @@ def mandatory_tour_frequency(set_random_seed,
         mandatory_tour_frequency_spec.columns[choices.values],
         index=choices.index).reindex(persons_merged.local.index)
 
-    trace.print_summary('mandatory_tour_frequency', choices, value_counts=True)
+    tracing.print_summary('mandatory_tour_frequency', choices, value_counts=True)
 
     orca.add_column("persons", "mandatory_tour_frequency", choices)
 

activitysim/defaults/models/mode.py

@@ -9,7 +9,7 @@
 import yaml
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 
 from activitysim import skim as askim
 from .util.mode import _mode_choice_spec
@@ -202,8 +202,8 @@ def tour_mode_choice_simulate(tours_merged,
             additional_constants=tour_mode_choice_settings['CONSTANTS'],
             omx=omx_file)
 
-        trace.print_summary('tour_mode_choice_simulate %s' % tour_type,
-                            choices, value_counts=True)
+        tracing.print_summary('tour_mode_choice_simulate %s' % tour_type,
+                              choices, value_counts=True)
 
         choices_list.append(choices)
 
@@ -213,7 +213,7 @@ def tour_mode_choice_simulate(tours_merged,
 
     choices = pd.concat(choices_list)
 
-    trace.print_summary('tour_mode_choice_simulate all tour type', choices, value_counts=True)
+    tracing.print_summary('tour_mode_choice_simulate all tour type', choices, value_counts=True)
 
     orca.add_column("tours", "mode", choices)
 
@@ -260,8 +260,8 @@ def trip_mode_choice_simulate(tours_merged,
             additional_constants=trip_mode_choice_settings['CONSTANTS'],
             omx=omx_file)
 
-        trace.print_summary('trip_mode_choice_simulate %s' % tour_type,
-                            choices, value_counts=True)
+        tracing.print_summary('trip_mode_choice_simulate %s' % tour_type,
+                              choices, value_counts=True)
 
         choices_list.append(choices)
 
@@ -271,7 +271,7 @@ def trip_mode_choice_simulate(tours_merged,
 
     choices = pd.concat(choices_list)
 
-    trace.print_summary('trip_mode_choice_simulate all tour type', choices, value_counts=True)
+    tracing.print_summary('trip_mode_choice_simulate all tour type', choices, value_counts=True)
 
     orca.add_column("trips", "mode", choices)
 

activitysim/defaults/models/non_mandatory_scheduling.py

@@ -8,7 +8,7 @@
 import pandas as pd
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from .util.vectorize_tour_scheduling import vectorize_tour_scheduling
 
 
@@ -42,8 +42,8 @@ def non_mandatory_scheduling(set_random_seed,
 
     choices = vectorize_tour_scheduling(tours, alts, spec, chunk_size)
 
-    trace.print_summary('non_mandatory_scheduling tour_departure_and_duration',
-                        choices, describe=True)
+    tracing.print_summary('non_mandatory_scheduling tour_departure_and_duration',
+                          choices, describe=True)
 
     orca.add_column(
         "non_mandatory_tours", "tour_departure_and_duration", choices)

activitysim/defaults/models/non_mandatory_tour_frequency.py

@@ -9,7 +9,7 @@
 import pandas as pd
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from .util.misc import add_dependent_columns
 from activitysim.util import reindex
 from .util.non_mandatory_tour_frequency import process_non_mandatory_tours
@@ -77,7 +77,7 @@ def non_mandatory_tour_frequency(set_random_seed,
 
     choices = pd.concat(choices_list)
 
-    trace.print_summary('non_mandatory_tour_frequency', choices, value_counts=True)
+    tracing.print_summary('non_mandatory_tour_frequency', choices, value_counts=True)
 
     # FIXME - no need to reindex?
     orca.add_column("persons", "non_mandatory_tour_frequency", choices)

activitysim/defaults/models/school_location.py

@@ -9,7 +9,7 @@
 import numpy as np
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from .util.misc import add_dependent_columns
 
 
@@ -79,7 +79,7 @@ def school_location_simulate(set_random_seed,
     logger.info("%s school_taz choices min: %s max: %s" %
                 (len(choices.index), choices.min(), choices.max()))
 
-    trace.print_summary('school_taz', choices, describe=True)
+    tracing.print_summary('school_taz', choices, describe=True)
 
     orca.add_column("persons", "school_taz", choices)
 

activitysim/defaults/models/workplace_location.py

@@ -7,7 +7,7 @@
 import orca
 
 from activitysim import activitysim as asim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 from .util.misc import add_dependent_columns
 
 
@@ -63,7 +63,7 @@ def workplace_location_simulate(set_random_seed,
     logger.info("%s workplace_taz choices min: %s max: %s" %
                 (len(choices.index), choices.min(), choices.max()))
 
-    trace.print_summary('workplace_taz', choices, describe=True)
+    tracing.print_summary('workplace_taz', choices, describe=True)
 
     orca.add_column("persons", "workplace_taz", choices)
 

activitysim/defaults/tables/skims.py

@@ -8,7 +8,7 @@
 import orca
 
 from activitysim import skim
-from activitysim.defaults import trace
+from activitysim.defaults import tracing
 
 logger = logging.getLogger(__name__)
 

activitysim/defaults/test/configs/logging.yaml

@@ -33,14 +33,14 @@ logging:
 
     logfile:
       class: logging.FileHandler
-      filename: logfile.log
+      filename: !!python/object/apply:activitysim.defaults.tracing.log_file_path ['asim.log']
       mode: w
       formatter: simpleFormatter
       level: !!python/name:logging.NOTSET
 
     tracefile:
       class: logging.FileHandler
-      filename: hhtrace.log
+      filename: !!python/object/apply:activitysim.defaults.tracing.log_file_path ['hhtrace.log']
       mode: w
       formatter: simpleFormatter
       level: !!python/name:logging.NOTSET

activitysim/defaults/test/test_trace.py

@@ -6,7 +6,7 @@
 
 import orca
 
-from .. import trace as trace
+from .. import tracing as tracing
 
 
 def close_handlers():
@@ -23,7 +23,7 @@ def test_bad_custom_config_file(capsys):
     orca.add_injectable("configs_dir", configs_dir)
 
     custom_config_file = os.path.join(os.path.dirname(__file__), 'configs', 'xlogging.yaml')
-    trace.config_logger(custom_config_file=custom_config_file)
+    tracing.config_logger(custom_config_file=custom_config_file)
 
     logger = logging.getLogger('activitysim')
 
@@ -59,7 +59,7 @@ def test_config_logger(capsys):
     configs_dir = os.path.join(os.path.dirname(__file__))
     orca.add_injectable("configs_dir", configs_dir)
 
-    trace.config_logger()
+    tracing.config_logger()
 
     logger = logging.getLogger('activitysim')
 
@@ -101,7 +101,7 @@ def test_no_config(capsys):
     # remove existing hanlers or basicConfig is a NOP
     logging.getLogger().handlers = []
 
-    trace.config_logger(basic=True)
+    tracing.config_logger(basic=True)
 
     logger = logging.getLogger()
     file_handlers = [h for h in logger.handlers if type(h) is logging.FileHandler]

activitysim/defaults/trace.py → activitysim/defaults/tracing.py

@@ -10,11 +10,20 @@
 TRACE_LOGGER = __name__
 ASIM_LOGGER = 'activitysim'
 
-tracer = logging.getLogger(TRACE_LOGGER)
+
+logger_trace = logging.getLogger(TRACE_LOGGER)
 
 LOGGING_CONF_FILE_NAME = 'logging.yaml'
 
 
+# for use in logging.yaml tag to inject log file path
+# filename: !!python/object/apply:activitysim.defaults.tracing.log_file_path ['asim.log']
+def log_file_path(name):
+    output_dir = orca.get_injectable('output_dir')
+    f = os.path.join(output_dir, name)
+    return f
+
+
 def config_logger(custom_config_file=None, basic=False):
 
     # if log_config_file is not supplied
@@ -54,11 +63,11 @@ def config_logger(custom_config_file=None, basic=False):
 
 
 def trace_logger():
-    return tracer
+    return logger_trace
 
 
 def trace(msg):
-    tracer.info("TRACE: %s" % msg)
+    logger_trace.info("TRACE: %s" % msg)
 
 
 def print_summary(label, df, describe=False, value_counts=False):

example/configs/logging.yaml

@@ -33,14 +33,14 @@ logging:
 
     logfile:
       class: logging.FileHandler
-      filename: logfile.log
+      filename: !!python/object/apply:activitysim.defaults.tracing.log_file_path ['asim.log']
       mode: w
       formatter: simpleFormatter
       level: !!python/name:logging.NOTSET
 
     tracefile:
       class: logging.FileHandler
-      filename: hhtrace.log
+      filename: !!python/object/apply:activitysim.defaults.tracing.log_file_path ['hhtrace.log']
       mode: w
       formatter: simpleFormatter
       level: !!python/name:logging.NOTSET
@@ -63,3 +63,4 @@ logging:
       class: !!python/name:logging.Formatter
       format: '%(asctime)s - %(levelname)s - %(name)s - %(message)s'
       datefmt: '%d/%m/%Y %H:%M:%S'
+

example/simulation.py

@@ -5,6 +5,10 @@
 import os
 
 
+orca.add_injectable("output_dir", 'output')
+defaults.tracing.config_logger()
+
+
 orca.run(["school_location_simulate"])
 orca.run(["workplace_location_simulate"])
 print orca.get_table("persons").distance_to_work.describe()

sandbox/logging.yaml

@@ -33,14 +33,14 @@ logging:
 
     logfile:
       class: logging.FileHandler
-      filename: logfile.log
+      filename: !!python/object/apply:activitysim.defaults.tracing.log_file_path ['asim.log']
       mode: w
       formatter: simpleFormatter
       level: !!python/name:logging.NOTSET
 
     tracefile:
       class: logging.FileHandler
-      filename: hhtrace.log
+      filename: !!python/object/apply:activitysim.defaults.tracing.log_file_path ['hhtrace.log']
       mode: w
       formatter: simpleFormatter
       level: !!python/name:logging.NOTSET