Giter VIP home page Giter VIP logo

Comments (3)

deep8324 avatar deep8324 commented on May 25, 2024

The issue exists even with polars v 0.20.3

from polars.

jcmuel avatar jcmuel commented on May 25, 2024

Hi @deep8324,

the data schema of the DataFrame in your example is not well-defined, so it's no surprise that you get an error. It seems like the actual schema that the example seems to represent is the following:

OrderedDict([('offer', Struct({'my_value': Int64, 'condition': List(Struct({'applicationId': Int64, 'conditionRequestReason': List(Struct({'a': Int64}))}))}))])

The data for the list of struct with the field a contains a list with an empty struct [{}]. It is not clear what this is supposed to represent. When you explicitly specify the schema as mentioned above, then this would represent a list with a single struct where the value for a is null. This is also the behavior that you can observe when you run the following example. Note that in the example below, the well_defined_data contains an empty list [] instead of [{}]. The incomplete_schema_data is exactly your example, but with additional schema information, such that you can read the data anyway.

# pylint: disable=missing-class-docstring, missing-function-docstring
""" Test for reading NDJSON files with nested fields. """
import io
import json
import unittest
from typing import Sequence, Any, cast

import polars as pl
import polars.testing


class TestNdJson(unittest.TestCase):
    def test_json_format(self):
        well_defined_data = io.StringIO(
            """{"offer": {"my_value": 0, "condition": [{"applicationId": 0, "conditionRequestReason": []}]}}
            {"offer": {"my_value": 0, "condition": [{"applicationId": 0, "conditionRequestReason": [{"a":0}]}]}}""")

        # Initialize the frame from a sequence of dictionaries.
        dicts = cast(Sequence[dict[str, Any]],
                     (json.loads(line) for line in well_defined_data))
        frame_from_dicts = pl.from_dicts(dicts)
        print(frame_from_dicts.schema)

        # Initialize the frame from the NDJSON file.
        frame_from_ndjson = pl.read_ndjson(well_defined_data)
        print(frame_from_ndjson.schema)

        # Compare the content of the frames.
        polars.testing.assert_frame_equal(frame_from_dicts, frame_from_ndjson)

        # Initialize the frame from a malformed NDJSON
        incomplete_schema_data = io.StringIO(
            """{"offer": {"my_value": 0, "condition": [{"applicationId": 0, "conditionRequestReason": [{}]}]}}""")
        frame_with_schema = pl.read_ndjson(incomplete_schema_data, schema=frame_from_ndjson.schema)
        frame_with_schema_export = frame_with_schema.write_ndjson()

        self.assertEqual(
            '{"offer":{"my_value":0,"condition":[{"applicationId":0,"conditionRequestReason":[{"a":null}]}]}}\n',
            frame_with_schema_export)


if __name__ == '__main__':
    unittest.main()

However, I can observe that without schema information, the behavior of from_dicts and read_ndjson differs when the data contains the awkward list with the empty struct [{}].

    def test_read_ndjson_list_of_awkward_struct(self):
        input_data = io.StringIO(
            """{"offer": {"my_value": 0, "condition": [{"applicationId": 0, "conditionRequestReason": [{}]}]}}
            {"offer": {"my_value": 0, "condition": [{"applicationId": 0, "conditionRequestReason": [{"a":0}]}]}}""")

        # Initialize the frame from a sequence of dictionaries.
        dicts = cast(Sequence[dict[str, Any]],
                     (json.loads(line) for line in input_data))
        frame_from_dicts = pl.from_dicts(dicts)
        print(frame_from_dicts.schema)

        # Initialize the frame from the NDJSON file.
        frame_from_ndjson = pl.read_ndjson(input_data)
        print(frame_from_ndjson.schema)

        # Compare the content of the frames.
        polars.testing.assert_frame_equal(frame_from_dicts, frame_from_ndjson)

The behavior of from_dicts seems to be a bit unexpected:

>>> frame_from_dicts
shape: (2, 1)
┌─────────────────────────┐
│ offer                   │
│ ---                     │
│ struct[2]               │
╞═════════════════════════╡
│ {0,[{0,[{null,null}]}]} │
│ {0,[{0,[{null,0}]}]}    │
└─────────────────────────┘
>>> frame_from_dicts.schema
OrderedDict([('offer', Struct({'my_value': Int64, 'condition': List(Struct({'applicationId': Int64, 'conditionRequestReason': List(Struct({'': Null, 'a': Int64}))}))}))])

from polars.

jcmuel avatar jcmuel commented on May 25, 2024

Enclosed is a small simple example, where JSON decode doesn't determine the correct schema for a list of integer. It works for list of string, but not for list of integer.

# pylint: disable=missing-class-docstring, missing-function-docstring, too-few-public-methods
""" Unit tests for the polars JSON decode functionality. """
import io
import pytest
import polars as pl
import polars.testing


class TestPolarsJsonDecode:
    @pytest.mark.parametrize('test_name, input_ndjson', [
        ("str", """{"list_field": ["a", "b"]}
                   {"list_field": []}
                   {"list_field": ["c", "d", "e"]}"""),
        ("int", """{"list_field": [1, 2]}
                   {"list_field": []}
                   {"list_field": [4, 5, 6]}""")
    ])
    def test_json_decode_list_of_basic_type(self, test_name, input_ndjson):
        print(f"Reading list of {test_name}...")
        input_buf = io.StringIO(input_ndjson)
        frame_from_ndjson = pl.read_ndjson(input_buf)

        # pylint: disable-next=assignment-from-no-return
        series_with_json = pl.Series(values=input_buf).str.strip_chars_start()
        series_decoded_unnested = series_with_json.str.json_decode().struct.unnest()

        assert frame_from_ndjson.schema == series_decoded_unnested.schema
        polars.testing.assert_frame_equal(frame_from_ndjson, series_decoded_unnested)


if __name__ == '__main__':
    pytest.main()

from polars.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.