Merge pull request #23 from keitheis/renamed_turn_logging_things

Renamed turn_logging_...thing

Author: keitheis

CHANGES.rst

@@ -1,6 +1,12 @@
 (Unrelease)
 ===================
 
+ - Renamed:
+
+   - ``turn_logging_datetime(on=True)``
+   - ``turn_logging_thread_name(on=False)``
+   - ``turn_logging_process_id(on=False)``
+
  - Support most same APIs between alog and Alogger.
  - Add ``alog.pdir()`` for handy replacing ``[attr for attr in dir(obj)
    if not attr.startswith("_")]``.

README.rst

@@ -10,8 +10,7 @@ Alog
 .. image:: http://img.shields.io/pypi/v/alog.svg?style=flat
    :target: https://pypi.org/pypi/alog
 
-Python logging for Humans. Your goto logging module without panic on context 
-swtich.
+Your goto Pythonlogging module without panic on context swtich.
 
 **Warning:** No more ``logger = logging.getLogger(__name__)`` in your every file.
 
@@ -95,12 +94,36 @@ with ``logging`` module:
     2016-11-23 12:16:30 INFO  [__main__:1] Hello log!
 
 
+Tips
+----
+
+.. code-block:: python
+
+    import alog
+
+    a_complex_json_dict = {...}  # or a_complex_dict
+    alog.info(alog.pformat(a_complex_dict))
+
+    restaurant = Restaurant(...)
+    alog.info(alog.pdir(restaurant))
+    # or just skip attributes starts with "__":
+    alog.info(alog.pdir(restaurant, str_not_startswith="__"))
+    # instead of
+    alog.info([attr for attr in dir(restaurant) if attr.startswith("_")])
+
+    # Play threads?
+    alog.turn_logging_thread_name(on=True)
+    # Processes?
+    alog.turn_logging_process_id(on=True)
+    # No datetime wanted?
+    alog.turn_logging_datetime(on=False)
+
 Why should you use logging instead of print
 -------------------------------------------
 
 The main goal of logging is to figure out what was going on and to get the
-insights. ``print``, by default, does only pure string output. No timestamp, no
-module hint, and no level control, comparing to a pretty logging record.
+insight. ``print``, by default, does simply pure string output. No timestamp,
+no module hint, and no level control, comparing to a pretty logging record.
 
 Lets start with ``aproject/models/user.py`` :
 

alog/__init__.py

@@ -67,7 +67,7 @@ def reset_global_alog():
     info = default_logger.info
     debug = default_logger.debug
     log = default_logger.log
-    default_logger.turn_log_datetime(on=True)
+    default_logger.turn_logging_datetime(on=True)
 
 
 def init_alogger(alog_config, default_root_name=None):
@@ -91,19 +91,19 @@ def getLogger(*args, **kwargs):
 # --- Alogger APIs --- #
 
 
-def turn_log_datetime(on, alogger=None):
+def turn_logging_datetime(on, alogger=None):
     alogger = alogger or default_logger
-    return alogger.turn_log_datetime(on)
+    return alogger.turn_logging_datetime(on)
 
 
-def turn_thread_name(on, alogger=None):
+def turn_logging_thread_name(on, alogger=None):
     alogger = alogger or default_logger
-    return alogger.turn_thread_name(on)
+    return alogger.turn_logging_thread_name(on)
 
 
-def turn_process_id(on, alogger=None):
+def turn_logging_process_id(on, alogger=None):
     alogger = alogger or default_logger
-    return alogger.turn_process_id(on)
+    return alogger.turn_logging_process_id(on)
 
 
 def set_level(level, alogger=None):

alog/alogger.py

@@ -86,7 +86,7 @@ def _get_logger_showing_fs(self):
             fs = self.alog_config['default_format']
         return fs
 
-    def turn_log_datetime(self, on):
+    def turn_logging_datetime(self, on):
         if (
             self.alog_config.get('custom_format') or
             self.alog_config['showing_log_datetime'] == bool(on)
@@ -98,7 +98,7 @@ def turn_log_datetime(self, on):
             fs = "%(asctime)s " + fs
         self.set_format(fs, is_default=True)
 
-    def turn_thread_name(self, on):
+    def turn_logging_thread_name(self, on):
         if (
             self.alog_config.get('custom_format') or
             self.alog_config['showing_thread_name'] == bool(on)
@@ -109,7 +109,7 @@ def turn_thread_name(self, on):
         fs = self._get_logger_showing_fs()
         self.set_format(fs, is_default=True)
 
-    def turn_process_id(self, on):
+    def turn_logging_process_id(self, on):
         if (
             self.alog_config.get('custom_format') or
             self.alog_config['showing_process_id'] == bool(on)

tests/base.py

@@ -58,39 +58,39 @@ def test_warning(self):
     def test_warn(self):
         self._alog.warn(msg)
 
-    def test_turn_thread_name(self):
-        self._alog.turn_process_id(True)
-        self._alog.turn_thread_name(True)
+    def test_turn_logging_thread_name(self):
+        self._alog.turn_logging_process_id(True)
+        self._alog.turn_logging_thread_name(True)
 
-    def test_turn_thread_name_with_custom_format(self):
+    def test_turn_logging_thread_name_with_custom_format(self):
         self._alog.set_format("blah")
-        self._alog.turn_thread_name(True)
+        self._alog.turn_logging_thread_name(True)
 
-    def test_turn_process_id_with_custom_format(self):
+    def test_turn_logging_process_id_with_custom_format(self):
         self._alog.set_format("blah")
-        self._alog.turn_process_id(True)
+        self._alog.turn_logging_process_id(True)
 
-    def test_turn_log_datetime_with_custom_format(self):
+    def test_turn_logging_datetime_with_custom_format(self):
         self._alog.set_format("blah")
-        self._alog.turn_log_datetime(True)
+        self._alog.turn_logging_datetime(True)
 
     def test_not_turn_thread_name(self):
-        self._alog.turn_thread_name(True)
-        self._alog.turn_thread_name(False)
+        self._alog.turn_logging_thread_name(True)
+        self._alog.turn_logging_thread_name(False)
 
     def test_not_turn_process_id(self):
-        self._alog.turn_process_id(True)
-        self._alog.turn_process_id(False)
+        self._alog.turn_logging_process_id(True)
+        self._alog.turn_logging_process_id(False)
 
     def test_not_turn_process_id_and_turn_thread_name(self):
-        self._alog.turn_thread_name(True)
-        self._alog.turn_process_id(True)
-        self._alog.turn_process_id(False)
+        self._alog.turn_logging_thread_name(True)
+        self._alog.turn_logging_process_id(True)
+        self._alog.turn_logging_process_id(False)
 
     def test_turn_process_id_and_not_turn_thread_name(self):
-        self._alog.turn_thread_name(True)
-        self._alog.turn_process_id(True)
-        self._alog.turn_thread_name(False)
+        self._alog.turn_logging_thread_name(True)
+        self._alog.turn_logging_process_id(True)
+        self._alog.turn_logging_thread_name(False)
 
     def test_info(self):
         self._alog.info(msg)
@@ -122,5 +122,5 @@ class Thing(object):
         thing = Thing()
         thing._private_thing = True
         thing.public_thing = True
-        assert "public_thing" in str(self._alog.pdir(thing))
-        assert "_private_thing" not in str(self._alog.pdir(thing))
+        assert "public_thing" in self._alog.pdir(thing)
+        assert "_private_thing" not in self._alog.pdir(thing)