Python package: cdisc-rules-engine and Rules is a raw list

[bkharade]

I have installed cdisc-rules-engine using pip install cdisc-rules-engine on a windows machine and in addition to installing the library, I have also downloaded the rules cache (found in the resources/cache folder of this repository) and stored them in my project.

I tried to execute the steps provided at https://pypi.org/project/cdisc-rules-engine/#description

Step 1: Load the Rules
The rules can be loaded into an in-memory cache by doing the following:

import os
import pathlib
import pickle

from multiprocessing.managers import SyncManager
from cdisc_rules_engine.services.cache import InMemoryCacheService

class CacheManager(SyncManager):
pass

If you're working from a terminal you may need to

use SyncManager directly rather than define CacheManager

CacheManager.register("InMemoryCacheService", InMemoryCacheService)

def load_rules_cache(path_to_rules_cache):
cache_path = pathlib.Path(path_to_rules_cache)
manager = CacheManager()
manager.start()
cache = manager.InMemoryCacheService()

files = next(os.walk(cache_path), (None, None, []))[2]

for fname in files:
    with open(cache_path / fname, "rb") as f:
        cache.add_all(pickle.load(f))

return cache

Rules in this cache can also be accessed by standard and version using the get_rules_cache_key function.

from cdisc_rules_engine.utilities.utils import get_rules_cache_key

cache = load_rules_cache("path/to/rules/cache")

Note that the standard version is separated by a dash, not a period

cache_key_prefix = get_rules_cache_key("sdtmig", "3-4")
rules = cache.get_all_by_prefix(cache_key_prefix)
print(rules)

I was expecting rules will be a list of dictionaries as per documentation but I receive [['CORE-000351', 'CORE-000793', 'CORE-000252', 'CORE-000791']] (big list just shortened for discussion).

Can someone help me here if I am missing any settings.

[SFJohnson24]

hi @bkharade
i addressed your ticket as it was a documentation issue--apologies for the error in the docs.
rule_keys = cache.get_all_by_prefix(get_rules_cache_key("sdtmig", "3-4"))
rules = [cache.get(key) for key in rule_keys[0]]
you will need to use cache.get() with the returned list--the documentation has been updated to reflect this