Add PythonScript object in common module for easy interactions with a Python script body and refactor whole PythonProcessor, PythonFileHandler (now PythonFileReader), PythonExecutor and PythonResolver flow

Author: maksymuimanov

cache/spring-boot-python-executor-cache-autoconfigure/src/main/java/io/w4t3rcs/python/config/PythonCacheAutoConfiguration.java

@@ -9,8 +9,8 @@
 import io.w4t3rcs.python.condition.ResolverCacheLevelCondition;
 import io.w4t3rcs.python.executor.CachingPythonExecutor;
 import io.w4t3rcs.python.executor.PythonExecutor;
-import io.w4t3rcs.python.file.CachingPythonFileHandler;
-import io.w4t3rcs.python.file.PythonFileHandler;
+import io.w4t3rcs.python.file.CachingPythonFileReader;
+import io.w4t3rcs.python.file.PythonFileReader;
 import io.w4t3rcs.python.processor.CachingPythonProcessor;
 import io.w4t3rcs.python.processor.PythonProcessor;
 import io.w4t3rcs.python.properties.PythonCacheProperties;
@@ -36,7 +36,7 @@
  * </p>
  * <p>
  * Provides default {@link CacheKeyGenerator} and caching wrappers for
- * {@link PythonFileHandler}, {@link PythonResolverHolder}, {@link PythonExecutor}, and {@link PythonProcessor}
+ * {@link PythonFileReader}, {@link PythonResolverHolder}, {@link PythonExecutor}, and {@link PythonProcessor}
  * beans if present in the context.
  * </p>
  * <p>
@@ -50,7 +50,7 @@
  *
  * @see PythonCacheProperties
  * @see CacheKeyGenerator
- * @see CachingPythonFileHandler
+ * @see CachingPythonFileReader
  * @see CachingPythonResolverHolder
  * @see CachingPythonExecutor
  * @see CachingPythonProcessor
@@ -76,22 +76,22 @@ public CacheKeyGenerator cacheKeyGenerator(PythonCacheProperties cacheProperties
     }
 
     /**
-     * Wraps the existing {@link PythonFileHandler} with caching capabilities
+     * Wraps the existing {@link PythonFileReader} with caching capabilities
      * when file cache level is enabled.
      *
      * @param cacheProperties non-null Python cache configuration properties
-     * @param pythonFileHandler non-null delegate {@link PythonFileHandler} bean
+     * @param pythonFileReader non-null delegate {@link PythonFileReader} bean
      * @param cacheManager non-null Spring cache manager for cache resolution
-     * @return a caching-enabled {@link PythonFileHandler} bean marked as primary
+     * @return a caching-enabled {@link PythonFileReader} bean marked as primary
      */
     @Bean
     @Primary
-    @ConditionalOnBean(PythonFileHandler.class)
+    @ConditionalOnBean(PythonFileReader.class)
     @Conditional(FileCacheLevelCondition.class)
-    public PythonFileHandler cachingPythonFileHandler(PythonCacheProperties cacheProperties,
-                                                      PythonFileHandler pythonFileHandler,
-                                                      CacheManager cacheManager) {
-        return new CachingPythonFileHandler(cacheProperties, pythonFileHandler, cacheManager);
+    public PythonFileReader cachingPythonFileHandler(PythonCacheProperties cacheProperties,
+                                                     PythonFileReader pythonFileReader,
+                                                     CacheManager cacheManager) {
+        return new CachingPythonFileReader(cacheProperties, pythonFileReader, cacheManager);
     }
 
     /**

cache/spring-boot-python-executor-cache-autoconfigure/src/test/java/io/w4t3rcs/python/CachingPythonLevelConfigurationTests.java

@@ -3,8 +3,8 @@
 import io.w4t3rcs.python.config.PythonCacheAutoConfiguration;
 import io.w4t3rcs.python.executor.CachingPythonExecutor;
 import io.w4t3rcs.python.executor.PythonExecutor;
-import io.w4t3rcs.python.file.CachingPythonFileHandler;
-import io.w4t3rcs.python.file.PythonFileHandler;
+import io.w4t3rcs.python.file.CachingPythonFileReader;
+import io.w4t3rcs.python.file.PythonFileReader;
 import io.w4t3rcs.python.processor.CachingPythonProcessor;
 import io.w4t3rcs.python.processor.PythonProcessor;
 import io.w4t3rcs.python.resolver.CachingPythonResolverHolder;
@@ -37,14 +37,14 @@ class CachingPythonLevelConfigurationTests {
     @TestPropertySource(properties = "spring.python.cache.levels=file")
     class OnlyFileTests {
         @Autowired
-        private PythonFileHandler pythonFileHandler;
+        private PythonFileReader pythonFileReader;
         @Autowired
-        private List<PythonFileHandler> pythonFileHandlers;
+        private List<PythonFileReader> pythonFileReaders;
 
         @Test
         void testMandatoryBeansLoad() {
-            Assertions.assertInstanceOf(CachingPythonFileHandler.class, pythonFileHandler);
-            Assertions.assertEquals(2, pythonFileHandlers.size());
+            Assertions.assertInstanceOf(CachingPythonFileReader.class, pythonFileReader);
+            Assertions.assertEquals(2, pythonFileReaders.size());
         }
     }
 
@@ -97,7 +97,7 @@ void testMandatoryBeansLoad() {
     @TestPropertySource(properties = "spring.python.cache.levels=file, resolver, executor, processor")
     class MultipleLevelsTests {
         @Autowired
-        private PythonFileHandler pythonFileHandler;
+        private PythonFileReader pythonFileReader;
         @Autowired
         private PythonResolverHolder pythonResolverHolder;
         @Autowired
@@ -107,7 +107,7 @@ class MultipleLevelsTests {
 
         @Test
         void testMandatoryBeansLoad() {
-            Assertions.assertInstanceOf(CachingPythonFileHandler.class, pythonFileHandler);
+            Assertions.assertInstanceOf(CachingPythonFileReader.class, pythonFileReader);
             Assertions.assertInstanceOf(CachingPythonResolverHolder.class, pythonResolverHolder);
             Assertions.assertInstanceOf(CachingPythonExecutor.class, pythonExecutor);
             Assertions.assertInstanceOf(CachingPythonProcessor.class, pythonProcessor);
@@ -117,8 +117,8 @@ void testMandatoryBeansLoad() {
     @TestConfiguration
     static class TestBeansConfiguration {
         @Bean
-        public PythonFileHandler pythonFileHandler() {
-            return Mockito.mock(PythonFileHandler.class);
+        public PythonFileReader pythonFileHandler() {
+            return Mockito.mock(PythonFileReader.class);
         }
 
         @Bean

cache/spring-boot-python-executor-cache/src/main/java/io/w4t3rcs/python/cache/impl/HashCacheKeyGenerator.java

@@ -3,7 +3,7 @@
 import io.w4t3rcs.python.cache.CacheKeyGenerator;
 import io.w4t3rcs.python.exception.CacheKeyGenerationException;
 import io.w4t3rcs.python.executor.CachingPythonExecutor;
-import io.w4t3rcs.python.file.CachingPythonFileHandler;
+import io.w4t3rcs.python.file.CachingPythonFileReader;
 import io.w4t3rcs.python.processor.CachingPythonProcessor;
 import io.w4t3rcs.python.properties.PythonCacheProperties;
 import io.w4t3rcs.python.resolver.CachingPythonResolverHolder;
@@ -33,7 +33,7 @@
  *
  * @see CacheKeyGenerator
  * @see PythonCacheProperties.KeyProperties
- * @see CachingPythonFileHandler
+ * @see CachingPythonFileReader
  * @see CachingPythonResolverHolder
  * @see CachingPythonExecutor
  * @see CachingPythonProcessor

cache/spring-boot-python-executor-cache/src/main/java/io/w4t3rcs/python/exception/PythonCacheException.java

@@ -1,7 +1,7 @@
 package io.w4t3rcs.python.exception;
 
 import io.w4t3rcs.python.executor.CachingPythonExecutor;
-import io.w4t3rcs.python.file.CachingPythonFileHandler;
+import io.w4t3rcs.python.file.CachingPythonFileReader;
 import io.w4t3rcs.python.processor.CachingPythonProcessor;
 import io.w4t3rcs.python.resolver.CachingPythonResolverHolder;
 
@@ -12,7 +12,7 @@
  * handling in the Python integration context.
  * </p>
  *
- * @see CachingPythonFileHandler
+ * @see CachingPythonFileReader
  * @see CachingPythonResolverHolder
  * @see CachingPythonExecutor
  * @see CachingPythonProcessor

cache/spring-boot-python-executor-cache/src/main/java/io/w4t3rcs/python/executor/CachingPythonExecutor.java

@@ -4,6 +4,7 @@
 import io.w4t3rcs.python.dto.PythonExecutionResponse;
 import io.w4t3rcs.python.exception.PythonCacheException;
 import io.w4t3rcs.python.properties.PythonCacheProperties;
+import io.w4t3rcs.python.script.PythonScript;
 import org.springframework.cache.Cache;
 import org.springframework.cache.CacheManager;
 
@@ -71,17 +72,15 @@ public CachingPythonExecutor(PythonCacheProperties cacheProperties, PythonExecut
      */
     @Override
     @SuppressWarnings("unchecked")
-    public <R> PythonExecutionResponse<R> execute(String script, Class<? extends R> resultClass) {
+    public <R> PythonExecutionResponse<R> execute(PythonScript script, Class<? extends R> resultClass) {
         try {
-            String key = keyGenerator.generateKey(script, resultClass);
+            String scriptBody = script.toString();
+            String key = keyGenerator.generateKey(scriptBody, resultClass);
             PythonExecutionResponse<R> cachedResult = (PythonExecutionResponse<R>) cache.get(key, PythonExecutionResponse.class);
-            if (cachedResult != null) {
-                return cachedResult;
-            } else {
-                PythonExecutionResponse<R> result = pythonExecutor.execute(script, resultClass);
-                cache.put(key, result);
-                return result;
-            }
+            if (cachedResult != null) return cachedResult;
+            PythonExecutionResponse<R> result = pythonExecutor.execute(script, resultClass);
+            cache.put(key, result);
+            return result;
         } catch (Exception e) {
             throw new PythonCacheException(e);
         }