WOLFRAM

LocalObject[]

represents a new anonymous local object.

LocalObject["file:///"]

represents a local object with a given file path.

LocalObject["relpath"]

represents a local object with the given relative path.

LocalObject["relpath","lbase"]

represents a local object relative to the base lbase.

Details

  • Relative paths are resolved with respect to $LocalBase.
  • LocalObject[File["path"]] and LocalObject[relpath,File["path"]] are also supported.
  • DeleteObject[LocalObject[]] removes a local object.
  • LocalObject[]["Properties"] gives the list of all supported properties of the given local object.
  • LocalObject[]["property"] gives the value of the specified property for the given local object.
  • Properties of local objects include:
  • "URL"the absolute file: URL of the local object
    "Type"the type of information stored in the local object
    "ObjectFile"the absolute path of the metadata file
    "DataFile"the absolute path of the data file
  • LocalObject[][All] gives an association of propertyvalue pairs for all properties of the given local object.

Examples

open allclose all

Basic Examples  (3)Summary of the most common use cases

An unnamed local object:

Out[1]=1

A named local object in the user's local base directory:

Out[1]=1

A named local object in a subdirectory of the user's local base directory:

Out[2]=2

Remove a local object:

Out[1]=1

Scope  (8)Survey of the scope of standard use cases

Local objects can be used with Put and Get to store expressions persistently:

Out[1]=1
Out[2]=2

Local objects can be used with Export and Import to store data persistently:

Out[1]=1
Out[2]=2

Local objects can be used with CopyFile to store files persistently:

Out[2]=2

Import the file stored in the local object:

Out[3]=3

Local objects can be used with Save to save definitions persistently:

Out[2]=2

Definitions saved can be read into the Wolfram Language using Get:

Out[5]=5

Local objects can be used with DumpSave to save definitions persistently:

Out[2]=2

Clear definitions for f:

Restore the definitions for f from the local object:

Local objects can be deleted with DeleteObject:

Local objects can be listed with LocalObjects:

Out[1]=1

Create a local object:

Out[1]=1

Display information about the local object:

Out[2]=2

Give the list of all known properties:

Out[3]=3

Give the value of a specific property:

Out[4]=4

Give an association of all property-value pairs:

Out[5]=5

Generalizations & Extensions  (3)Generalized and extended use cases

Local objects can be created in any file:

Out[1]=1

File paths can also be specified with File:

Out[1]=1
Out[2]=2

The base for resolving relative paths can be given as the second argument:

Out[2]=2

The base can be taken from another local object:

Out[3]=3
Out[4]=4

Applications  (1)Sample problems that can be solved with this function

Delete all existing local objects:

Properties & Relations  (9)Properties of the function, and connections to other functions

Relative paths are resolved with respect to $LocalBase:

Out[1]=1
Out[2]=2

Local symbols are local objects stored in the directory $LocalSymbolBase:

Out[1]=1

A file scheme URL can be converted to a path by ExpandFileName:

Out[1]=1
Out[2]=2
Out[3]=3

A local object can be given directly in ExpandFileName:

Out[1]=1

File scheme URLs and local objects can be used in FileNameSplit:

Out[1]=1
Out[2]=2

CloudObject provides for persistent storage in the cloud:

Out[1]=1

Find all local objects used as caches:

Out[1]=1

RenameFile works on local objects:

Out[1]=1
Out[2]=2
Out[3]=3

FileNameJoin works with local objects:

Out[1]=1

Possible Issues  (2)Common pitfalls and unexpected behavior

Applying LocalObject by itself does not create the referenced file:

Out[1]=1
Out[2]=2
Out[3]=3

Only by writing content is it actually created:

Out[4]=4
Out[5]=5

Most properties are undefined for nonexistant objects:

Out[1]=1
Wolfram Research (2015), LocalObject, Wolfram Language function, https://reference.wolfram.com/language/ref/LocalObject.html.
Wolfram Research (2015), LocalObject, Wolfram Language function, https://reference.wolfram.com/language/ref/LocalObject.html.

Text

Wolfram Research (2015), LocalObject, Wolfram Language function, https://reference.wolfram.com/language/ref/LocalObject.html.

Wolfram Research (2015), LocalObject, Wolfram Language function, https://reference.wolfram.com/language/ref/LocalObject.html.

CMS

Wolfram Language. 2015. "LocalObject." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/LocalObject.html.

Wolfram Language. 2015. "LocalObject." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/LocalObject.html.

APA

Wolfram Language. (2015). LocalObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/LocalObject.html

Wolfram Language. (2015). LocalObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/LocalObject.html

BibTeX

@misc{reference.wolfram_2025_localobject, author="Wolfram Research", title="{LocalObject}", year="2015", howpublished="\url{https://reference.wolfram.com/language/ref/LocalObject.html}", note=[Accessed: 12-April-2025 ]}

@misc{reference.wolfram_2025_localobject, author="Wolfram Research", title="{LocalObject}", year="2015", howpublished="\url{https://reference.wolfram.com/language/ref/LocalObject.html}", note=[Accessed: 12-April-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_localobject, organization={Wolfram Research}, title={LocalObject}, year={2015}, url={https://reference.wolfram.com/language/ref/LocalObject.html}, note=[Accessed: 12-April-2025 ]}

@online{reference.wolfram_2025_localobject, organization={Wolfram Research}, title={LocalObject}, year={2015}, url={https://reference.wolfram.com/language/ref/LocalObject.html}, note=[Accessed: 12-April-2025 ]}