[dev] Refactor repository

Author: d-leroy

.gitignore

@@ -1,4 +1,6 @@
 .vscode
 .venv
+dist
 **/__pycache__
-**/build
+**/build
+**/*.egg-info

MANIFEST.in

@@ -0,0 +1,3 @@
+include src/api/CMakeLists.txt
+include src/api/MoniLogger.cc
+include src/api/monilogger_module.cc

README.md

@@ -1,3 +1,4 @@
-# monilog
+# monilogger
 
+A Python logging and monitoring toolbox for C++ and Python-embedding applications.
 

setup.py

@@ -2,12 +2,14 @@
 import re
 import subprocess
 import sys
+from sysconfig import get_paths
 
 from pybind11 import get_cmake_dir
 from pybind11.setup_helpers import Pybind11Extension, build_ext
 from setuptools import Extension, find_packages, setup
+from distutils import ccompiler
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"
 
 # Convert distutils Windows platform specifiers to CMake -A arguments
 PLAT_TO_CMAKE = {
@@ -110,29 +112,30 @@ def build_extension(self, ext):
         subprocess.check_call(["cmake", "--build", "."] + build_args, cwd=build_temp)
 
 ext_modules = [
-    CMakeExtension("monilog._monilog", sourcedir="src")
+    CMakeExtension("monilogger._monilogger", sourcedir="src/api")
 ]
 
 # ext_modules = [
-#     Pybind11Extension("monilog._monilog",
-#         ["src/MoniLog.cc"],
+#     Pybind11Extension("monilogger._monilogger",
+#         ["src/MoniLogger.cc"],
+#         include_dirs = ["src/monilogger/include"],
 #         define_macros = [('VERSION_INFO', __version__)],
 #         cxx_std=17
 #         ),
 # ]
 
 setup(
-    name="monilog",
+    name="monilogger",
     version=__version__,
     author="Dorian Leroy",
     author_email="[email protected]",
-    url="https://github.com/cea-hpc/monilog",
+    url="https://github.com/cea-hpc/monilogger",
     description="A Python logging and monitoring toolbox for C++ applications.",
     long_description="",
-    packages=["monilog"],
-    package_dir={"": "src"},
+    packages=["monilogger"],
+    package_dir={"": "src/api"},
     package_data={
-        "monilog": ["include/MoniLog.h"],
+        "monilogger": ["include/MoniLogger.h"],
     },
     ext_modules=ext_modules,
     cmdclass={"build_ext": CMakeBuild},

src/CMakeLists.txt renamed to src/api/CMakeLists.txt

@@ -8,22 +8,20 @@ set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
 set(CMAKE_CXX_FLAGS "-Wall -Wextra -O3")
 
 # PROJECT
-project(monilog CXX)
+project(monilogger CXX)
 set(CMAKE_VERBOSE_MAKEFILE TRUE)
 
-set(PYBIND11_PYTHON_VERSION 3.8)
 find_package(Python COMPONENTS Interpreter Development REQUIRED)
 set(pybind11_DIR "${Python_SITELIB}/pybind11/share/cmake/pybind11")
 find_package(pybind11 REQUIRED)
-include_directories(${pybind11_INCLUDE_DIRS} monilog/include)
-
-add_library(monilog SHARED MoniLog.cc)
-target_link_libraries(monilog ${PYTHON_LIBRARIES} pybind11::embed)
+include_directories(${pybind11_INCLUDE_DIRS} monilogger/include)
 
+add_library(monilogger SHARED MoniLogger.cc)
+target_link_libraries(monilogger ${PYTHON_LIBRARIES} pybind11::embed)
 
 # Python extension
-pybind11_add_module(_monilog monilog_module.cc)
-set_target_properties(_monilog PROPERTIES
+pybind11_add_module(_monilogger monilogger_module.cc)
+set_target_properties(_monilogger PROPERTIES
         BUILD_WITH_INSTALL_RPATH FALSE
         LINK_FLAGS "-Wl,-rpath,$ORIGIN/")
-target_link_libraries(_monilog PUBLIC monilog)
+target_link_libraries(_monilogger PUBLIC monilogger)

src/MoniLog.cc renamed to src/api/MoniLogger.cc

@@ -1,8 +1,8 @@
-#include <MoniLog.h>
+#include <MoniLogger.h>
 
 namespace py = pybind11;
 
-namespace MoniLog
+namespace MoniLogger
 {
     namespace
     {
@@ -135,7 +135,8 @@ namespace MoniLog
     void register_base_events(std::map<std::string, size_t> events)
     {
         size_t size(0);
-        for (auto it = events.begin(); it != events.end(); ++it) {
+        for (auto it = events.begin(); it != events.end(); ++it)
+        {
             size = std::max(size, it->second);
         }
         size++;
@@ -158,6 +159,16 @@ namespace MoniLog
         }
     }
 
+    std::list<std::string> get_base_events()
+    {
+        std::list<std::string> result;
+        for (auto evt : base_events)
+        {
+            result.emplace_back(evt.first);
+        }
+        return result;
+    }
+
     void clear_events()
     {
         base_events.clear();
@@ -217,15 +228,15 @@ namespace MoniLog
         return registered_moniloggers[event];
     }
 
-    void trigger(std::string event_name, std::shared_ptr<MoniLogExecutionContext> context)
+    void trigger(std::string event_name, std::shared_ptr<MoniLoggerExecutionContext> context)
     {
         for (py::function monilogger : event_to_moniloggers[event_name])
         {
             monilogger(context);
         }
     }
 
-    void trigger(size_t event_id, std::shared_ptr<MoniLogExecutionContext> context)
+    void trigger(size_t event_id, std::shared_ptr<MoniLoggerExecutionContext> context)
     {
         std::list<py::function> moniloggers = registered_moniloggers[event_id];
         for (py::function monilogger : moniloggers)
@@ -234,7 +245,7 @@ namespace MoniLog
         }
     }
 
-    void bootstrap_monilog(std::vector<std::string> python_path,
+    void bootstrap_monilogger(std::vector<std::string> python_path,
         std::vector<std::string> python_scripts,
         std::string interface_module,
         std::function<void (py::module_, py::object)> interface_module_initializer)
@@ -248,13 +259,13 @@ namespace MoniLog
             append_to_path(python_path[i]);
         }
 
-        // // Initializing the MoniLog Python module.
-        py::module_ monilogModule = py::module_::import("monilog");
-        py::module_ monilogInternalModule = py::module_::import("monilog._monilog");
+        // // Initializing the MoniLogger Python module.
+        py::module_ moniloggerModule = py::module_::import("monilogger");
+        py::module_ moniloggerInternalModule = py::module_::import("monilogger._monilogger");
 
         // // Initializing the user-provided interface module exposing C++ variables to Python scripts.
         py::module_ interface_py_module = py::module_::import(interface_module.c_str());
-        py::object ctx = (py::object) monilogInternalModule.attr("MoniLogExecutionContext");
+        py::object ctx = (py::object) moniloggerInternalModule.attr("MoniLoggerExecutionContext");
         interface_module_initializer(interface_py_module, ctx);
 
         // Loading the user-provided Python scripts containing monilogger definitions.
@@ -265,4 +276,19 @@ namespace MoniLog
     }
 }
 
+PYBIND11_MODULE(_monilogger, m) {
+    m.attr("__name__") = "monilogger._monilogger";
+	py::class_<MoniLogger::MoniLoggerExecutionContext, std::shared_ptr<MoniLogger::MoniLoggerExecutionContext>>(m, "MoniLoggerExecutionContext")
+        .def(py::init<>());
+    m.def("register", &MoniLogger::register_monilogger);
+    m.def("stop", &MoniLogger::unregister_monilogger);
+    m.def("define_event", &MoniLogger::register_composite_event);
+    m.def("define_basic_events", &MoniLogger::register_base_events);
+    m.def("get_basic-events", &MoniLogger::get_base_events);
+    m.def("emit_event", [](std::string event_name, std::shared_ptr<MoniLogger::MoniLoggerExecutionContext> scope)
+    {
+        MoniLogger::trigger(event_name, scope);
+    });
+}
+
 

src/api/monilogger/__init__.py

@@ -0,0 +1,2 @@
+from .monilogger import *
+del monilogger

src/monilog/include/MoniLog.h renamed to src/api/monilogger/include/MoniLogger.h

@@ -1,5 +1,5 @@
-#ifndef __MONILOG_H_
-#define __MONILOG_H_
+#ifndef __MONILOGGER_H_
+#define __MONILOGGER_H_
 
 #include <fstream>
 #include <iomanip>
@@ -14,15 +14,15 @@
 
 namespace py = pybind11;
 
-namespace MoniLog
+namespace MoniLogger
 {
-    struct MoniLogExecutionContext
+    struct MoniLoggerExecutionContext
     {
-        std::string name = "MoniLogExecutionContext";
+        std::string name = "MoniLoggerExecutionContext";
 
-        MoniLogExecutionContext() {}
-        MoniLogExecutionContext(std::string name) : name(name) {}
-        virtual ~MoniLogExecutionContext() = default;
+        MoniLoggerExecutionContext() {}
+        MoniLoggerExecutionContext(std::string name) : name(name) {}
+        virtual ~MoniLoggerExecutionContext() = default;
     };
 
     void register_composite_event(std::string event_name, std::list<std::string> triggering_events);
@@ -31,6 +31,8 @@ namespace MoniLog
 
     void register_base_events(std::map<std::string, size_t> events);
 
+    std::list<std::string> get_base_events();
+
     void clear_events();
 
     __attribute__((visibility("default")))
@@ -43,12 +45,12 @@ namespace MoniLog
 
     std::list<py::function> get_registered_moniloggers(size_t event);
 
-    void trigger(std::string event_name, std::shared_ptr<MoniLogExecutionContext> scope);
+    void trigger(std::string event_name, std::shared_ptr<MoniLoggerExecutionContext> scope);
 
-    void trigger(size_t event_id, std::shared_ptr<MoniLogExecutionContext> scope);
+    void trigger(size_t event_id, std::shared_ptr<MoniLoggerExecutionContext> scope);
 
     __attribute__((visibility("default")))
-    void bootstrap_monilog(std::vector<std::string> python_path,
+    void bootstrap_monilogger(std::vector<std::string> python_path,
         std::vector<std::string> python_scripts,
         std::string interface_module,
         std::function<void (py::module_, py::object)> interface_module_initializer);

src/monilog/monilog.py renamed to src/api/monilogger/monilogger.py

@@ -1,5 +1,5 @@
 import functools
-import monilog._monilog as mnlg
+import monilogger._monilogger as mnlg
 
 __all__ = ('register', 'register_monilogger', 'define_event')
 

src/api/monilogger_module.cc

@@ -0,0 +1,16 @@
+#include "MoniLogger.h"
+
+PYBIND11_MODULE(_monilogger, m) {
+    m.attr("__name__") = "monilogger._monilogger";
+	py::class_<MoniLogger::MoniLoggerExecutionContext, std::shared_ptr<MoniLogger::MoniLoggerExecutionContext>>(m, "MoniLoggerExecutionContext")
+        .def(py::init<>());
+    m.def("register", &MoniLogger::register_monilogger);
+    m.def("stop", &MoniLogger::unregister_monilogger);
+    m.def("define_event", &MoniLogger::register_composite_event);
+    m.def("define_basic_events", &MoniLogger::register_base_events);
+    m.def("get_basic-events", &MoniLogger::get_base_events);
+    m.def("emit_event", [](std::string event_name, std::shared_ptr<MoniLogger::MoniLoggerExecutionContext> scope)
+    {
+        MoniLogger::trigger(event_name, scope);
+    });
+}