Documentation for literal-or-new-object-identity

src/codemodder/scripts/generate_docs.py

@@ -174,6 +174,10 @@ class DocMetadata:
         importance="Low",
         guidance_explained="Removing future imports is safe and will not cause any issues.",
     ),
+    "literal-or-new-object-identity": DocMetadata(
+        importance="Low",
+        guidance_explained="Since literals and new objects have their own identities, comparisons against them using `is` operators are most likely a bug and thus we deem the change safe.",
+    ),
 }
 
 

src/core_codemods/docs/pixee_python_literal-or-new-object-identity.md

@@ -0,0 +1,9 @@
+The `is` and `is not` operator will only return `True` when the expression have the same `id`, that is, `a is b` is equivalent to `id(a) == id(b)`. New objects and literals have their own identities and thus shouldn't be compared with using the `is` or `is not` operators.
+
+Our changes look something like this:
+
+```diff
+def foo(l):
+-    return l is [1,2,3]
++    return l == [1,2,3]
+```

src/core_codemods/literal_or_new_object_identity.py

@@ -12,7 +12,7 @@ class LiteralOrNewObjectIdentity(BaseCodemod, NameResolutionMixin):
     DESCRIPTION = SUMMARY
     REFERENCES = [
         {
-            "url": "https://docs.python.org/3/library/operator.html#operator.is_",
+            "url": "https://docs.python.org/3/library/stdtypes.html#comparisons",
             "description": "",
         },
     ]