sqlce 0.1.2__tar.gz → 0.1.3__tar.gz

{sqlce-0.1.2 → sqlce-0.1.3}/.gitignore

@@ -41,6 +41,7 @@ install_manifest.txt
 compile_commands.json
 vcpkg_installed/
 Testing/
+tests/sdf/
 .cache/
 
 .idea/

sqlce-0.1.3/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.2
+Name: sqlce
+Version: 0.1.3
+Summary: Cross-platform lib for reading SQL Server CE (.sdf)
+Author-Email: boykopovar <boykopovar@gmail.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: C++
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Project-URL: Homepage, https://github.com/boykopovar/sqlce
+Project-URL: Issues, https://github.com/boykopovar/sqlce/issues
+Requires-Python: >=3.8
+Provides-Extra: dev
+Requires-Dist: scikit-build-core>=0.10; extra == "dev"
+Requires-Dist: pybind11>=2.12; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pythonnet; extra == "dev"
+Description-Content-Type: text/markdown
+
+# sqlce
+
+![C++](https://img.shields.io/badge/C%2B%2B-20-blue?logo=cplusplus&logoColor=white)
+![Python](https://img.shields.io/badge/python-3.8%2B-blue?logo=python&logoColor=white)
+![Platform](https://img.shields.io/badge/platform-cross--platform-lightgrey)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Reverse engineered](https://img.shields.io/badge/Reverse%20engineered%20with-🔬-red)
+
+## [Ru README](docs/ru/RuReadme.md)
+
+Reverse engineering of the `.sdf` (SQL Server Compact Edition 4.0) binary file format.
+
+Analysis of the format's internal structure based on decompiled SQL CE components. The goal is to provide a cross-platform, runtime-independent implementation for reading `.sdf` files.
+
+> Intended solely for interoperability with existing `.sdf` files. Does not contain any original product source code.
+
+- `core/` — C++ parser implementation
+- `bindings/` — Bindings for the C++ library to other languages
+- `python/sqlce/` — Python API
+- `research/` — Experimental scripts
+
+### Example
+
+```bash
+pip install sqlce
+```
+
+```python
+from sqlce import SdfDatabase
+
+db = SdfDatabase("example.sdf", password="secret123")
+
+for table_name in db.list_tables():
+    print(table_name, db.table_schema(table_name))
+    for row in db.read_table(table_name):
+        print(row)
+```
+
+The current implementation supports reading the list of tables, table schemas, and table contents (including password-protected databases). It is implemented in C++.
+
+### Testing
+
+```bash
+pytest
+```
+
+The tests use a locally installed SQL CE engine (via ODBC) to generate `.sdf` files containing predefined data and verify that the parser produces identical results. Therefore, the test suite can only be run on Windows with SQL Server Compact 4.0 installed. Test files are created in `tests/sdf/` and are automatically removed before and after each test run.
+
+### Documentation
+
+The documentation is currently concise but includes usage examples and tests.
+
+[Documentation](docs/en/python.md)
+
+
+[Code Style Conventions](docs/CONVENTIONS.md) (Pull requests are welcome.)

sqlce-0.1.3/README.md

@@ -0,0 +1,56 @@
+# sqlce
+
+![C++](https://img.shields.io/badge/C%2B%2B-20-blue?logo=cplusplus&logoColor=white)
+![Python](https://img.shields.io/badge/python-3.8%2B-blue?logo=python&logoColor=white)
+![Platform](https://img.shields.io/badge/platform-cross--platform-lightgrey)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Reverse engineered](https://img.shields.io/badge/Reverse%20engineered%20with-🔬-red)
+
+## [Ru README](docs/ru/RuReadme.md)
+
+Reverse engineering of the `.sdf` (SQL Server Compact Edition 4.0) binary file format.
+
+Analysis of the format's internal structure based on decompiled SQL CE components. The goal is to provide a cross-platform, runtime-independent implementation for reading `.sdf` files.
+
+> Intended solely for interoperability with existing `.sdf` files. Does not contain any original product source code.
+
+- `core/` — C++ parser implementation
+- `bindings/` — Bindings for the C++ library to other languages
+- `python/sqlce/` — Python API
+- `research/` — Experimental scripts
+
+### Example
+
+```bash
+pip install sqlce
+```
+
+```python
+from sqlce import SdfDatabase
+
+db = SdfDatabase("example.sdf", password="secret123")
+
+for table_name in db.list_tables():
+    print(table_name, db.table_schema(table_name))
+    for row in db.read_table(table_name):
+        print(row)
+```
+
+The current implementation supports reading the list of tables, table schemas, and table contents (including password-protected databases). It is implemented in C++.
+
+### Testing
+
+```bash
+pytest
+```
+
+The tests use a locally installed SQL CE engine (via ODBC) to generate `.sdf` files containing predefined data and verify that the parser produces identical results. Therefore, the test suite can only be run on Windows with SQL Server Compact 4.0 installed. Test files are created in `tests/sdf/` and are automatically removed before and after each test run.
+
+### Documentation
+
+The documentation is currently concise but includes usage examples and tests.
+
+[Documentation](docs/en/python.md)
+
+
+[Code Style Conventions](docs/CONVENTIONS.md) (Pull requests are welcome.)

sqlce-0.1.3/core/include/sdf/domain/DateTimeValue.hpp

@@ -0,0 +1,36 @@
+#ifndef SDF_DOMAIN_DATE_TIME_VALUE_HPP
+#define SDF_DOMAIN_DATE_TIME_VALUE_HPP
+
+#include <cstdint>
+#include <string>
+
+namespace sdf::domain
+{
+
+    struct CalendarDate
+    {
+        int year;
+        int month;
+        int day;
+    };
+
+    class DateTimeValue
+    {
+    public:
+        DateTimeValue();
+        DateTimeValue(std::int32_t daysSinceEpoch, std::uint32_t ticksSinceMidnight);
+
+        std::uint32_t MillisecondsSinceMidnight() const;
+        std::int32_t DaysSinceEpoch() const;
+        CalendarDate Date() const;
+
+        std::string ToString() const;
+
+    private:
+        std::int32_t _daysSinceEpoch;
+        std::uint32_t _ticksSinceMidnight;
+    };
+
+}
+
+#endif

sqlce-0.1.3/core/src/domain/DateTimeValue.cpp

@@ -0,0 +1,135 @@
+#include "sdf/domain/DateTimeValue.hpp"
+
+#include <cstdio>
+
+namespace sdf::domain
+{
+
+namespace
+{
+
+constexpr int EpochYear = 1900;
+constexpr int EpochMonth = 1;
+constexpr int EpochDay = 1;
+
+bool IsLeapYear(int year)
+{
+    return (year % 4 == 0 && year % 100 != 0) || (year % 400 == 0);
+}
+
+int DaysInMonth(int year, int month)
+{
+    static constexpr int daysByMonth[12] = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
+    if (month == 2 && IsLeapYear(year))
+    {
+        return 29;
+    }
+    return daysByMonth[month - 1];
+}
+
+CalendarDate AddDays(int year, int month, int day, std::int32_t daysToAdd)
+{
+    if (daysToAdd >= 0)
+    {
+        std::uint32_t remaining = static_cast<std::uint32_t>(daysToAdd);
+        while (remaining > 0)
+        {
+            const int daysLeftInMonth = DaysInMonth(year, month) - day;
+            if (static_cast<std::uint32_t>(daysLeftInMonth) >= remaining)
+            {
+                day += static_cast<int>(remaining);
+                remaining = 0;
+            }
+            else
+            {
+                remaining -= static_cast<std::uint32_t>(daysLeftInMonth) + 1;
+                day = 1;
+                month += 1;
+                if (month > 12)
+                {
+                    month = 1;
+                    year += 1;
+                }
+            }
+        }
+    }
+    else
+    {
+        std::uint32_t remaining = static_cast<std::uint32_t>(-daysToAdd);
+        while (remaining > 0)
+        {
+            const int daysIntoMonth = day - 1;
+            if (static_cast<std::uint32_t>(daysIntoMonth) >= remaining)
+            {
+                day -= static_cast<int>(remaining);
+                remaining = 0;
+            }
+            else
+            {
+                remaining -= static_cast<std::uint32_t>(daysIntoMonth) + 1;
+                month -= 1;
+                if (month < 1)
+                {
+                    month = 12;
+                    year -= 1;
+                }
+                day = DaysInMonth(year, month);
+            }
+        }
+    }
+    return CalendarDate{year, month, day};
+}
+
+}
+
+DateTimeValue::DateTimeValue() : _daysSinceEpoch(0), _ticksSinceMidnight(0)
+{
+}
+
+DateTimeValue::DateTimeValue(std::int32_t daysSinceEpoch, std::uint32_t ticksSinceMidnight)
+    : _daysSinceEpoch(daysSinceEpoch), _ticksSinceMidnight(ticksSinceMidnight)
+{
+}
+
+std::uint32_t DateTimeValue::MillisecondsSinceMidnight() const
+{
+    return static_cast<std::uint32_t>((static_cast<std::uint64_t>(_ticksSinceMidnight) * 10ULL + 1ULL) / 3ULL);
+}
+
+std::int32_t DateTimeValue::DaysSinceEpoch() const
+{
+    return _daysSinceEpoch;
+}
+
+CalendarDate DateTimeValue::Date() const
+{
+    return AddDays(EpochYear, EpochMonth, EpochDay, _daysSinceEpoch);
+}
+
+std::string DateTimeValue::ToString() const
+{
+    const CalendarDate date = Date();
+
+    const std::uint32_t milliseconds = MillisecondsSinceMidnight();
+    const std::uint32_t totalSeconds = milliseconds / 1000;
+    const std::uint32_t ms = milliseconds % 1000;
+    const std::uint32_t hours = (totalSeconds / 3600) % 24;
+    const std::uint32_t minutes = (totalSeconds / 60) % 60;
+    const std::uint32_t seconds = totalSeconds % 60;
+
+    char buffer[32];
+    std::snprintf(
+        buffer,
+        sizeof(buffer),
+        "%04d-%02d-%02d %02u:%02u:%02u.%03u",
+        date.year,
+        date.month,
+        date.day,
+        hours,
+        minutes,
+        seconds,
+        ms);
+    return std::string(buffer);
+}
+
+}

{sqlce-0.1.2 → sqlce-0.1.3}/core/src/parsing/RowDecoder.cpp

@@ -232,9 +232,9 @@ domain::ColumnValue RowDecoder::DecodeFixed(const domain::ColumnDef& column, std
 
         case domain::ColumnType::DateTime:
         {
-            const std::uint32_t milliseconds = infrastructure::ReadUInt32LE(chunk, 0);
-            const std::uint32_t days = infrastructure::ReadUInt32LE(chunk, 4);
-            return domain::ColumnValue(domain::ColumnValueStorage(domain::DateTimeValue(milliseconds, days)));
+            const std::uint32_t ticks = infrastructure::ReadUInt32LE(chunk, 0);
+            const std::int32_t days = infrastructure::ReadInt32LE(chunk, 4);
+            return domain::ColumnValue(domain::ColumnValueStorage(domain::DateTimeValue(days, ticks)));
         }
 
         case domain::ColumnType::Money:
@@ -318,4 +318,4 @@ domain::ColumnValue RowDecoder::DecodeLob(
     return domain::ColumnValue(domain::ColumnValueStorage(payload));
 }
 
-}
+}

{sqlce-0.1.2 → sqlce-0.1.3}/docs/build.txt

@@ -1,8 +1,8 @@
 pip install -e . -v --config-settings=cmake.args="-G Ninja;-DCMAKE_CXX_COMPILER=g++;-DCMAKE_C_COMPILER=gcc;-DSDF_BUILD_PYTHON_BINDINGS=ON"
 python -m build --wheel -C cmake.args="-G Ninja;-DCMAKE_CXX_COMPILER=g++;-DCMAKE_C_COMPILER=gcc;-DSDF_BUILD_PYTHON_BINDINGS=ON"
 
-git tag v0.1.1
-git push origin v0.1.1
+git tag v0.1.2
+git push origin v0.1.2
 
 git tag -d v0.1.0
 git push origin --delete v0.1.0

sqlce-0.1.2/PKG-INFO → sqlce-0.1.3/docs/ru/RuReadme.md

@@ -1,44 +1,26 @@
-Metadata-Version: 2.2
-Name: sqlce
-Version: 0.1.2
-Summary: Cross-platform lib for reading SQL Server CE (.sdf)
-Author-Email: boykopovar <boykopovar@gmail.com>
-License: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: C++
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX :: Linux
-Project-URL: Homepage, https://github.com/boykopovar/sqlce
-Project-URL: Issues, https://github.com/boykopovar/sqlce/issues
-Requires-Python: >=3.8
-Provides-Extra: dev
-Requires-Dist: scikit-build-core>=0.10; extra == "dev"
-Requires-Dist: pybind11>=2.12; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Description-Content-Type: text/markdown
-
 # sqlce
 
+![C++](https://img.shields.io/badge/C%2B%2B-20-blue?logo=cplusplus&logoColor=white)
+![Python](https://img.shields.io/badge/python-3.8%2B-blue?logo=python&logoColor=white)
+![Platform](https://img.shields.io/badge/platform-cross--platform-lightgrey)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Reverse engineered](https://img.shields.io/badge/Reverse%20engineered%20with-🔬-red)
+
+## [En README](../../README.md)
+
 Реверс-инжиниринг бинарного формата `.sdf` (SQL Server Compact Edition 4.0).
- 
-Анализ внутреннего устройства формата по декомпилированным компонентам SQL CE. Цель - предоставить кроссплатформенную и независимую от рантайма реализацию чтения `.sdf` и документацию формата.
+
+Анализ внутреннего устройства формата по декомпилированным компонентам SQL CE. Цель - предоставить кроссплатформенную и независимую от рантайма реализацию чтения `.sdf`.
+
+> Исключительно для интероперабельности с существующими файлами `.sdf` формата. Не содержит оригинальный код продукта.
 
 
 - `core/` - реализация парсера на C++
-- `bindings/` - Биндинги для C++ библиотеки к другим языкам
+- `bindings/` - Биндинги C++ библиотеки к другим языкам
 - `python/sqlce/` - Python API
 - `research/` - Экспериментальные скрипты
 
+### Пример
 
 ```bash
 pip install sqlce
@@ -57,10 +39,20 @@ for table_name in db.list_tables():
 
 Текущая [реализация](main.py) поддерживает чтение (поддерживается передача пароля) списка таблиц, структуры таблиц, содержимого записей. Использует c++.
 
-[Документация](docs/ru/python.md)
+### Тестирование
+
+```bash
+pytest
+```
+
+Тесты используют установленный на устройстве SQL CE движок (через ODBC) для генерации `.sdf`-файлов с заранее известными данными и сверяют их с результатом чтения реализованным парсером - так что запуск возможен только на Windows с установленным SQL Server Compact 4.0. Файлы создаются в `tests/sdf/` и автоматически удаляются в начале и после каждого прогона.
 
-[Documentation](docs/en/python.md)
 
-[Соглашения по написанию кода](docs/CONVENTIONS.md) (PR приветствуются)
+### Документация
 
-> Исключительно для интероперабельности с существующими файлами `.sdf` формата. Не содержит оригинальный код продукта.
+На данный момент документация краткая, но есть примеры и тесты.
+
+[Документация](python.md)
+
+
+[Соглашения по написанию кода](docs/CONVENTIONS.md) (PR приветствуются)

{sqlce-0.1.2 → sqlce-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "sqlce"
-version = "0.1.2"
+version = "0.1.3"
 description = "Cross-platform lib for reading SQL Server CE (.sdf)"
 readme = "README.md"
 license = { text = "MIT" }
@@ -60,4 +60,10 @@ dev = [
     "build",
     "twine",
     "pytest",
+    "pytest-cov",
+    "pythonnet"
 ]
+
+[tool.pytest.ini_options]
+addopts = "--cov=sqlce --cov-report=term-missing"
+testpaths = ["tests"]

{sqlce-0.1.2 → sqlce-0.1.3}/requirements.txt

@@ -3,3 +3,5 @@ scikit-build-core>=0.10
 twine
 build
 pytest
+pytest-cov
+pythonnet

sqlce-0.1.3/tests/conftest.py

@@ -0,0 +1,80 @@
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Callable
+from typing import Dict
+from typing import Iterator
+from typing import Optional
+
+import pytest
+
+from tests.sdf_factory import cleanup_sdf_dir
+from tests.sdf_factory import create_engine_default_encrypted_database
+from tests.sdf_factory import create_platform_default_encrypted_database
+from tests.sdf_factory import create_plain_database
+from tests.sdf_factory import get_sdf_dir
+from tests.sdf_factory import open_connection as sdf_open_connection
+
+BASE_DIR = Path(__file__).parent
+
+SCENARIO_PLAIN = "plain40"
+SCENARIO_PLATFORM_DEFAULT = "platform_default40"
+SCENARIO_ENGINE_DEFAULT = "engine_default40"
+
+PLATFORM_DEFAULT_PASSWORD = "P1atform!Default"
+ENGINE_DEFAULT_PASSWORD = "Eng1ne-Default"
+
+
+@pytest.fixture(scope="session", autouse=True)
+def _clean_sdf_dir_at_session_start() -> None:
+    cleanup_sdf_dir(BASE_DIR)
+
+@pytest.fixture
+def sdf_dir() -> Iterator[Path]:
+    directory = get_sdf_dir(BASE_DIR)
+    yield directory
+    cleanup_sdf_dir(BASE_DIR)
+
+
+@dataclass(frozen=True)
+class SdfScenario:
+    name: str
+    path: Path
+    password: Optional[str]
+
+    def open_connection(self):
+        return sdf_open_connection(self.path, self.password)
+
+    def open_database(self):
+        from sqlce import SdfDatabase
+
+        if self.password is None:
+            return SdfDatabase(str(self.path))
+        return SdfDatabase(str(self.path), self.password)
+
+
+def _build_plain_scenario(sdf_dir: Path) -> SdfScenario:
+    path = create_plain_database(sdf_dir)
+    return SdfScenario(name=SCENARIO_PLAIN, path=path, password=None)
+
+
+def _build_platform_default_scenario(sdf_dir: Path) -> SdfScenario:
+    path = create_platform_default_encrypted_database(sdf_dir, PLATFORM_DEFAULT_PASSWORD)
+    return SdfScenario(name=SCENARIO_PLATFORM_DEFAULT, path=path, password=PLATFORM_DEFAULT_PASSWORD)
+
+
+def _build_engine_default_scenario(sdf_dir: Path) -> SdfScenario:
+    path = create_engine_default_encrypted_database(sdf_dir, ENGINE_DEFAULT_PASSWORD)
+    return SdfScenario(name=SCENARIO_ENGINE_DEFAULT, path=path, password=ENGINE_DEFAULT_PASSWORD)
+
+
+_SCENARIO_BUILDERS: Dict[str, Callable[[Path], SdfScenario]] = {
+    SCENARIO_PLAIN: _build_plain_scenario,
+    SCENARIO_PLATFORM_DEFAULT: _build_platform_default_scenario,
+    SCENARIO_ENGINE_DEFAULT: _build_engine_default_scenario,
+}
+
+
+@pytest.fixture(params=[SCENARIO_PLAIN, SCENARIO_PLATFORM_DEFAULT, SCENARIO_ENGINE_DEFAULT])
+def sdf_scenario(request, sdf_dir: Path) -> SdfScenario:
+    builder = _SCENARIO_BUILDERS[request.param]
+    return builder(sdf_dir)