Giter Site home page Giter Site logo

Empty object encodes as array about json.lua HOT 2 OPEN

rxi avatar rxi commented on July 30, 2024 1
Empty object encodes as array

from json.lua.

Comments (2)

tmpgnh avatar tmpgnh commented on July 30, 2024 2

Thank you for the explanation. I actually felt that the second guarantee

data encoded with json.encode() will result in the same data when json.decode() is used

is being violated---cf. the empty JSON object '{}'. For my use case which parses and then returns JSON I'm thinking to patch json.lua along these lines:

@@ -56,6 +56,9 @@
 end
 
 
+local json_object_tag = {}
+
+
 local function encode_table(val, stack)
   local res = {}
   stack = stack or {}
@@ -65,7 +68,7 @@
 
   stack[val] = true
 
-  if rawget(val, 1) ~= nil or next(val) == nil then
+  if getmetatable(val) ~= json_object_tag and (rawget(val, 1) ~= nil or next(val) == nil) then
     -- Treat as array -- check keys are valid and it is not sparse
     local n = 0
     for k in pairs(val) do
@@ -337,6 +340,7 @@
     if chr == "}" then break end
     if chr ~= "," then decode_error(str, i, "expected '}' or ','") end
   end
+  setmetatable(res, json_object_tag)
   return res, i
 end

from json.lua.

rxi avatar rxi commented on July 30, 2024

This is expected behaviour, there's a few reasons this choice was made though:

In Lua there's no distinction between an "array" and a "map". When json.lua encounters a table it tries to determine first if it's a valid array -- it does so by checking to make sure it doesn't contain any non-numerical keys, and that it contains the keys in the inclusive range 1 to n without any gaps -- by this definition an empty table is considered an array.

This behaviour was chosen as in typical cases you won't be encoding an empty object, and, if you are, in many cases that object can be stored as an array and treated like an object once loaded (lua, javascript). Typically if you have an empty table you're writing to JSON in lua it's a table that you're using as an array.

The library makes only the following guarantees: that valid JSON will decode correctly, that encoded JSON will be valid, and that data encoded with json.encode() will result in the same data when json.decode() is used.

If you want to force your empty table to be encoded as an object, a simple work around might be to add a dummy value to it, for example:

json.encode { _ = false } -- => {"_":false}

from json.lua.

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.