0Pricing
Lua Academy · Leçon

Écrire un fichier de module

Créez un module en renvoyant une table de fonctions depuis un fichier .lua.

Écrire un fichier de module est une leçon Lua Academy gratuite sur CoddyKit. Ceci est la leçon 2 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Lua Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Lua Academy comprend 4 leçons au total.

Le modèle de module de base

Le modèle de module Lua standard consiste à créer une table locale M, à lui ajouter des fonctions et des valeurs, puis à la renvoyer à la fin. Cette table constitue l'API publique du module. Toutes les autres variables locales du fichier sont privées.

-- stringutils.lua
local M = {}

function M.trim(s)
  return s:match("^%s*(.-)%s*$")
end

function M.split(s, sep)
  local t = {}
  for p in s:gmatch("[^"..sep.."]+") do t[#t+1]=p end
  return t
end

return M

-- Usage:
-- local su = require("stringutils")
-- print(su.trim("  hello  "))

État privé

Les variables déclarées local dans le fichier du module sont privées : les appelants ne peuvent pas y accéder. Les fonctions du module peuvent accéder à cet état privé en tant que valeurs capturées. Il s'agit du mécanisme d'encapsulation de Lua.

-- counter.lua
local M = {}
local count = 0   -- private state

function M.increment(n)
  count = count + (n or 1)
end

function M.reset()
  count = 0
end

function M.get()
  return count
end

return M

Module avec initialisation

Certains modules nécessitent une initialisation (configuration, connexions). Placez le code d'initialisation au niveau du module (en haut du fichier) ou dans une fonction explicite M.init(). L'approche au niveau du module s'exécute une fois lors du premier appel à require ; init() nécessite un appel explicite.

-- cache.lua
local M = {}
local store = {}   -- initialized at load time
local hits = 0
local misses = 0

function M.get(key)
  if store[key] ~= nil then
    hits = hits + 1
    return store[key]
  end
  misses = misses + 1
  return nil
end

function M.set(key, val) store[key] = val end
function M.stats() return {hits=hits, misses=misses} end

return M

Module avec classe

Un module peut exporter une classe : une table contenant une fonction constructeur. La table du module renvoyée contient la fonction new() et peut également servir de métatable de la classe.

-- point.lua
local Point = {}
Point.__index = Point

function Point.new(x, y)
  return setmetatable({x=x, y=y}, Point)
end

function Point:distance(other)
  local dx, dy = self.x-other.x, self.y-other.y
  return math.sqrt(dx*dx + dy*dy)
end

function Point:__tostring()
  return string.format("(%g,%g)", self.x, self.y)
end

return Point

-- Usage:
-- local Point = require("point")
-- local p = Point.new(3, 4)

Constantes du module

Exportez les constantes en les ajoutant à la table du module. Par convention, les constantes sont écrites en majuscules. Lua ne disposant pas de constantes, les utilisateurs peuvent techniquement les modifier, mais les noms en majuscules indiquent qu'il ne faut pas les changer.

-- colors.lua
local M = {}

M.RED   = {r=255, g=0,   b=0}
M.GREEN = {r=0,   g=255, b=0}
M.BLUE  = {r=0,   g=0,   b=255}
M.WHITE = {r=255, g=255, b=255}
M.BLACK = {r=0,   g=0,   b=0}

function M.toHex(c)
  return string.format("#%02X%02X%02X", c.r, c.g, c.b)
end

return M

Versionnement des modules

Incluez un champ de version dans votre module. Les appelants peuvent vérifier cette version pour garantir la compatibilité. Utilisez le versionnement sémantique (major.minor.patch).

-- mylib.lua
local M = {}
M._VERSION = "1.2.3"
M._NAME = "mylib"
M._DESCRIPTION = "My Lua library"

function M.hello(name)
  return "Hello, " .. (name or "World") .. "!"
end

return M

-- Usage:
local mylib = require("mylib")
print(mylib._VERSION)   -- 1.2.3
print(mylib.hello("Lua"))

Sous-modules

Les grandes bibliothèques sont divisées en sous-modules. Le module principal peut requérir et réexporter les sous-modules, ou chaque sous-module peut être utilisé indépendamment. Organisez les fichiers dans des répertoires correspondant au chemin du module.

-- mylib/init.lua  (loaded by require("mylib"))
local M = {}

M.strings = require("mylib.strings")
M.tables  = require("mylib.tables")
M.math    = require("mylib.math")

M._VERSION = "2.0.0"

return M

-- Users can require the whole library:
-- local mylib = require("mylib")
-- mylib.strings.trim(...)

-- Or individual sub-modules:
-- local strs = require("mylib.strings")

Module avec métatable

Rendez un module appelable en lui attribuant une métatable contenant __call. Cela est utile pour les modules qui sont principalement des fonctions, mais qui possèdent également des utilitaires : l'opération « principale » est l'appel, et les utilitaires sont des champs.

-- format.lua
local M = {}
setmetatable(M, {__call = function(_, fmt, ...)
  return string.format(fmt, ...)
end})

function M.pad(s, width, char)
  char = char or " "
  return string.rep(char, math.max(0, width - #s)) .. s
end

return M

-- Usage:
-- local fmt = require("format")
-- print(fmt("%.2f", 3.14))   -- 3.14
-- print(fmt.pad("42", 5))    --    42

Chargement différé des sous-modules

Utilisez __index pour charger les sous-modules de manière différée, uniquement lors de leur premier accès. Cela accélère le démarrage des grandes bibliothèques comportant de nombreux sous-modules.

-- biglib.lua
local M = {}
local submodules = {"strings", "tables", "math", "io"}

setmetatable(M, {
  __index = function(t, k)
    for _, name in ipairs(submodules) do
      if name == k then
        local mod = require("biglib." .. k)
        rawset(t, k, mod)
        return mod
      end
    end
    return nil
  end
})

return M

-- Loads biglib.strings only when accessed:
-- local lib = require("biglib")
-- lib.strings.trim(...)

Modèle de test des modules

Ajoutez une fonction ou un bloc de test en bas du fichier du module, exécuté conditionnellement uniquement lorsque le fichier est exécuté directement (et non lorsqu'il est requis). Les tests unitaires restent ainsi à proximité du code.

-- utils.lua
local M = {}

function M.clamp(v, lo, hi)
  return math.max(lo, math.min(hi, v))
end

-- Self-test: only runs when executed directly
if debug.getinfo(2, "S") == nil then
  -- Running as main script, not required
  print("Testing clamp...")
  assert(M.clamp(5, 0, 10) == 5)
  assert(M.clamp(-1, 0, 10) == 0)
  assert(M.clamp(15, 0, 10) == 10)
  print("All tests passed!")
end

return M

Vérification rapide

Quelle est la manière standard de définir un état privé dans un module Lua ?

Récapitulatif : écrire des modules

Résumé :

  • Modèle : local M = {} ... return M
  • Variables locales du fichier = privées ; champs de M = API publique
  • Le code au niveau du module s'exécute une fois lors du premier appel à require
  • Exportez les classes via un constructeur dans la table du module
  • Chargement différé des sous-modules via __index
  • Incluez _VERSION pour les vérifications de compatibilité

Questions Fréquemment Posées

La leçon « Écrire un fichier de module » est-elle gratuite ?

Oui — le texte complet de « Écrire un fichier de module » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Lua Academy, passe à CoddyKit PRO. Le cours Lua Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Écrire un fichier de module » ?

Créez un module en renvoyant une table de fonctions depuis un fichier .lua. Tu pratiques Lua Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Lua Academy ?

Aucune expérience préalable n'est requise. Lua Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 4.

Combien de temps prend la leçon « Écrire un fichier de module » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Lua Academy ?

Oui. Chaque leçon Lua Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

  1. La fonction require
  2. Écrire un fichier de module
  3. package.path et package.cpath
  4. Modèles de modules et bonnes pratiques
← Retour à Lua Academy